adspower-browser

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

AdsPower Local API with adspower-browser

使用adspower-browser的AdsPower Local API

The Skills CLI (npx adspower-browser) is the package manager for operate AdsPower browser profiles, groups, proxies, and application/category lists via the adspower-browser CLI.
Skills CLI(npx adspower-browser)是一款通过adspower-browser CLI来操作AdsPower浏览器配置文件、分组、代理以及应用/分类列表的包管理工具。

When to Use This Skill

何时使用该Skill

Apply when the user:
  • Asks to create, update, delete, or list AdsPower browser profiles
  • Mentions opening or closing browsers/profiles, fingerprint, UA, or proxy
  • Wants to manage groups, proxies, or check API status
  • Refers to AdsPower or adspower-browser (and MCP is not running or not desired)
Ensure AdsPower is running (default port 50325). Set
PORT
and
API_KEY
via environment or
--port
/
--api-key
if needed.
适用于以下用户场景:
  • 请求创建、更新、删除或列出AdsPower浏览器配置文件
  • 提及打开或关闭浏览器/配置文件、指纹、UA或代理
  • 想要管理分组、代理或检查API状态
  • 提到AdsPower或adspower-browser(且MCP未运行或不需要使用MCP)
请确保AdsPower处于运行状态(默认端口50325)。如有需要,可通过环境变量或
--port
/
--api-key
参数设置
PORT
API_KEY

How to Run

运行方式

bash
adspower-browser [--port PORT] [--api-key KEY] <command> [<arg>]
Two forms for
<arg>
:
  1. Single value (shorthand) — for profile-related commands, pass one profile ID or number:
    • adspower-browser open-browser <ProfileId>
    • adspower-browser close-browser <ProfileId>
    • adspower-browser get-profile-cookies <ProfileId>
    • adspower-browser get-browser-active <ProfileId>
    • adspower-browser get-profile-ua <ProfileId>
      (single ID)
    • adspower-browser new-fingerprint <ProfileId>
      (single ID)
  2. JSON string — full parameters for any command (see Command Reference below):
    • adspower-browser open-browser '{"profileId":"abc123","launchArgs":"..."}'
    • Commands with no params: omit
      <arg>
      or use
      '{}'
      .
bash
adspower-browser [--port PORT] [--api-key KEY] <command> [<arg>]
<arg>
的两种形式:
  1. 单一值(简写形式) — 针对配置文件相关命令,传入单个配置文件ID或编号:
    • adspower-browser open-browser <ProfileId>
    • adspower-browser close-browser <ProfileId>
    • adspower-browser get-profile-cookies <ProfileId>
    • adspower-browser get-browser-active <ProfileId>
    • adspower-browser get-profile-ua <ProfileId>
      (单个ID)
    • adspower-browser new-fingerprint <ProfileId>
      (单个ID)
  2. JSON字符串 — 任意命令的完整参数(见下方命令参考):
    • adspower-browser open-browser '{"profileId":"abc123","launchArgs":"..."}'
    • 无参数的命令:省略
      <arg>
      或使用
      '{}'

Essential Commands

核心命令

Browser profile – open/close

浏览器配置文件 – 打开/关闭

bash
adspower-browser open-browser <profileId>                    # Or JSON: profileId, profileNo?, ipTab?, launchArgs?, clearCacheAfterClosing?, cdpMask?
adspower-browser close-browser <profileId>                   # Or JSON: profileId? | profileNo? (one required)
bash
adspower-browser open-browser <profileId>                    # 或JSON格式:profileId, profileNo?, ipTab?, launchArgs?, clearCacheAfterClosing?, cdpMask?
adspower-browser close-browser <profileId>                   # 或JSON格式:profileId? | profileNo?(二者必填其一)

Browser profile – create/update/delete/list

浏览器配置文件 – 创建/更新/删除/列出

bash
adspower-browser create-browser '{"groupId":"0","proxyid":"random",...}'  # groupId + account field + proxy required
adspower-browser update-browser '{"profileId":"...",...}'    # profileId required
adspower-browser delete-browser '{"profileIds":["..."]}'     # profileIds required
adspower-browser get-browser-list '{}'                       # Or groupId?, limit?, page?, profileId?, profileNo?, sortType?, sortOrder?
adspower-browser get-opened-browser                          # No params
bash
adspower-browser create-browser '{"groupId":"0","proxyid":"random",...}'  # 必填groupId + 账户字段 + 代理信息
adspower-browser update-browser '{"profileId":"...",...}'    # 必填profileId
adspower-browser delete-browser '{"profileIds":["..."]}'     # 必填profileIds
adspower-browser get-browser-list '{}'                       # 可选参数:groupId?, limit?, page?, profileId?, profileNo?, sortType?, sortOrder?
adspower-browser get-opened-browser                          # 无参数

Browser profile – move/cookies/UA/fingerprint/cache/share/active

浏览器配置文件 – 移动/ Cookie / UA / 指纹 / 缓存 / 共享 / 状态检查

bash
adspower-browser move-browser '{"groupId":"1","userIds":["..."]}'   # groupId + userIds required
adspower-browser get-profile-cookies <profileId>             # Or JSON: profileId? | profileNo?
adspower-browser get-profile-ua <profileId>                  # Or JSON: profileId[]? | profileNo[]? (up to 10)
adspower-browser close-all-profiles                          # No params
adspower-browser new-fingerprint <profileId>                 # Or JSON: profileId[]? | profileNo[]? (up to 10)
adspower-browser delete-cache-v2 '{"profileIds":["..."],"type":["cookie","history"]}'  # type: local_storage|indexeddb|extension_cache|cookie|history|image_file
adspower-browser share-profile '{"profileIds":["..."],"receiver":"email@example.com"}' # receiver required; shareType?, content?
adspower-browser get-browser-active <profileId>              # Or JSON: profileId? | profileNo?
adspower-browser get-cloud-active '{"userIds":"id1,id2"}'    # userIds comma-separated, max 100
bash
adspower-browser move-browser '{"groupId":"1","userIds":["..."]}'   # 必填groupId + userIds
adspower-browser get-profile-cookies <profileId>             # 或JSON格式:profileId? | profileNo?
adspower-browser get-profile-ua <profileId>                  # 或JSON格式:profileId[]? | profileNo[]?(最多10个)
adspower-browser close-all-profiles                          # 无参数
adspower-browser new-fingerprint <profileId>                 # 或JSON格式:profileId[]? | profileNo[]?(最多10个)
adspower-browser delete-cache-v2 '{"profileIds":["..."],"type":["cookie","history"]}'  # type可选值:local_storage|indexeddb|extension_cache|cookie|history|image_file
adspower-browser share-profile '{"profileIds":["..."],"receiver":"email@example.com"}' # 必填receiver;可选参数:shareType?, content?
adspower-browser get-browser-active <profileId>              # 或JSON格式:profileId? | profileNo?
adspower-browser get-cloud-active '{"userIds":"id1,id2"}'    # userIds为逗号分隔格式,最多100个

Group

分组管理

bash
adspower-browser create-group '{"groupName":"My Group","remark":"..."}'   # groupName required
adspower-browser update-group '{"groupId":"1","groupName":"New Name"}'    # groupId + groupName required; remark? (null to clear)
adspower-browser get-group-list '{}'                         # groupName?, size?, page?
bash
adspower-browser create-group '{"groupName":"My Group","remark":"..."}'   # 必填groupName
adspower-browser update-group '{"groupId":"1","groupName":"New Name"}'    # 必填groupId + groupName;可选参数:remark?(设为null可清空)
adspower-browser get-group-list '{}'                         # 可选参数:groupName?, size?, page?

Application (categories)

应用(分类)

bash
adspower-browser check-status                                # No params – API availability
adspower-browser get-application-list '{}'                   # category_id?, page?, limit?
bash
adspower-browser check-status                                # 无参数 – 检查API可用性
adspower-browser get-application-list '{}'                   # 可选参数:category_id?, page?, limit?

Proxy

代理管理

bash
adspower-browser create-proxy '{"proxies":[{"type":"http","host":"127.0.0.1","port":"8080"}]}'  # type, host, port required per item
adspower-browser update-proxy '{"proxyId":"...","host":"..."}'   # proxyId required
adspower-browser get-proxy-list '{}'                         # limit?, page?, proxyId?
adspower-browser delete-proxy '{"proxyIds":["..."]}'        # proxyIds required, max 100
bash
adspower-browser create-proxy '{"proxies":[{"type":"http","host":"127.0.0.1","port":"8080"}]}'  # 每个代理项必填type、host、port
adspower-browser update-proxy '{"proxyId":"...","host":"..."}'   # 必填proxyId
adspower-browser get-proxy-list '{}'                         # 可选参数:limit?, page?, proxyId?
adspower-browser delete-proxy '{"proxyIds":["..."]}'        # 必填proxyIds,最多100个

Command Reference (full interface and parameters)

命令参考(完整接口与参数)

All parameter names are camelCase in JSON.
所有JSON参数名称均采用小驼峰命名法(camelCase)。

Browser Profile Management

浏览器配置文件管理

See references/browser-profile-management.md for open-browser, close-browser, create-browser, update-browser, delete-browser, get-browser-list, get-opened-browser, move-browser, get-profile-cookies, get-profile-ua, close-all-profiles, new-fingerprint, delete-cache-v2, share-profile, get-browser-active, get-cloud-active and their parameters.
关于open-browser、close-browser、create-browser、update-browser、delete-browser、get-browser-list、get-opened-browser、move-browser、get-profile-cookies、get-profile-ua、close-all-profiles、new-fingerprint、delete-cache-v2、share-profile、get-browser-active、get-cloud-active及其参数的详细信息,请查看references/browser-profile-management.md

Group Management

分组管理

See references/group-management.md for create-group, update-group, and get-group-list parameters.
关于create-group、update-group和get-group-list的参数详情,请查看references/group-management.md

Application Management

应用管理

See references/application-management.md for check-status and get-application-list parameters.
关于check-status和get-application-list的参数详情,请查看references/application-management.md

Proxy Management

代理管理

See references/proxy-management.md for create-proxy, update-proxy, get-proxy-list, and delete-proxy parameters.
关于create-proxy、update-proxy、get-proxy-list和delete-proxy的参数详情,请查看references/proxy-management.md

UserProxyConfig (inline proxy config for create-browser / update-browser)

UserProxyConfig(create-browser / update-browser的内联代理配置)

See references/user-proxy-config.md for all fields (proxy_soft, proxy_type, proxy_host, proxy_port, etc.) and example.
所有字段(proxy_soft、proxy_type、proxy_host、proxy_port等)及示例,请查看references/user-proxy-config.md

FingerprintConfig (fingerprint config for create-browser / update-browser)

FingerprintConfig(create-browser / update-browser的指纹配置)

See references/fingerprint-config.md for all fields (timezone, language, WebRTC, browser_kernel_config, random_ua, TLS, etc.) and example.
所有字段(timezone、language、WebRTC、browser_kernel_config、random_ua、TLS等)及示例,请查看references/fingerprint-config.md

Automation (Not Supported by This CLI)

自动化操作(本CLI不支持)

Commands such as
navigate
,
click-element
,
fill-input
,
screenshot
depend on a persistent browser connection and are not exposed by this CLI. Use the local-api-mcp MCP server for automation.
navigate
click-element
fill-input
screenshot
等命令需要持久化的浏览器连接,因此在本CLI中提供。如需自动化操作,请使用local-api-mcp MCP服务器。

Deep-Dive Documentation

深入文档

Reference docs with full enum values and field lists:
ReferenceDescriptionWhen to use
references/browser-profile-management.mdopen-browser, close-browser, create-browser, update-browser, delete-browser, get-browser-list, get-opened-browser, move-browser, get-profile-cookies, get-profile-ua, close-all-profiles, new-fingerprint, delete-cache-v2, share-profile, get-browser-active, get-cloud-active parameters.Any browser profile operation (open, create, update, delete, list, move, cookies, UA, cache, share, status).
references/group-management.mdcreate-group, update-group, get-group-list parameters.Creating, updating, or listing browser groups.
references/application-management.mdcheck-status, get-application-list parameters.Checking API availability or listing applications (categories).
references/proxy-management.mdcreate-proxy, update-proxy, get-proxy-list, delete-proxy parameters and enums.Creating, updating, listing, or deleting proxies.
references/user-proxy-config.mdFull userProxyConfig field list (proxy_soft, proxy_type, proxy_host, proxy_port, etc.) and example.Building inline proxy config for create-browser / update-browser when not using proxyid.
references/fingerprint-config.mdFull fingerprintConfig field list (timezone, language, WebRTC, browser_kernel_config, random_ua, TLS, etc.) and example.Building or editing fingerprint config for create-browser / update-browser.
references/browser-kernel-config.mdtype and version for
fingerprintConfig.browser_kernel_config
. Version must match type (Chrome vs Firefox).
Pinning or choosing a specific browser kernel (Chrome/Firefox and version) when creating or updating a browser.
references/ua-system-version.mdua_system_version enum for
fingerprintConfig.random_ua
: specific OS versions, generic “any version” per system, and omit behavior.
Constraining or randomizing UA by OS (e.g. Android only, or “any macOS version”) when creating or updating a browser.
Use these when you need the exact allowed values or semantics; the main skill text above only summarizes.
包含完整枚举值和字段列表的参考文档:
参考文档描述使用场景
references/browser-profile-management.md包含open-browserclose-browsercreate-browserupdate-browserdelete-browserget-browser-listget-opened-browsermove-browserget-profile-cookiesget-profile-uaclose-all-profilesnew-fingerprintdelete-cache-v2share-profileget-browser-activeget-cloud-active的参数详情。任意浏览器配置文件操作(打开、创建、更新、删除、列出、移动、Cookie、UA、缓存、共享、状态检查)。
references/group-management.md包含create-groupupdate-groupget-group-list的参数详情。创建、更新或列出浏览器分组。
references/application-management.md包含check-statusget-application-list的参数详情。检查API可用性或列出应用(分类)。
references/proxy-management.md包含create-proxyupdate-proxyget-proxy-listdelete-proxy的参数及枚举值详情。创建、更新、列出或删除代理。
references/user-proxy-config.md完整的userProxyConfig字段列表(proxy_soft、proxy_type、proxy_host、proxy_port等)及示例。当不使用proxyid时,为create-browser / update-browser构建内联代理配置。
references/fingerprint-config.md完整的fingerprintConfig字段列表(timezone、language、WebRTC、browser_kernel_config、random_ua、TLS等)及示例。为create-browser / update-browser创建或编辑指纹配置。
references/browser-kernel-config.md
fingerprintConfig.browser_kernel_config
typeversion参数说明。版本必须与类型匹配(Chrome或Firefox)。
在创建或更新浏览器时,固定或选择特定的浏览器内核(Chrome/Firefox及对应版本)。
references/ua-system-version.md
fingerprintConfig.random_ua
ua_system_version枚举值:特定操作系统版本、各系统通用的“任意版本”以及省略该参数的行为说明。
在创建或更新浏览器时,按操作系统约束或随机生成UA(例如仅安卓系统,或“任意macOS版本”)。
当你需要确切的允许值或语义说明时,请使用这些文档;本文上方的主要内容仅为摘要说明。