# @bitget-ai/bitget-agent-cli 中文文档

规范地址：https://npmcn.com/package/%40bitget-ai/bitget-agent-cli/

版本：3\.0\.0
npm 元数据更新时间：2026-06-22T08:41:13.504Z
中文译文更新时间：2026-11-08T04:58:26.465Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bitget-ai/bitget-agent-cli
原文对照：https://npmcn.com/package/%40bitget-ai/bitget-agent-cli/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：41.8 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-06-12T05:23:34.425Z
- 最新版本发布：2026-06-22T08:41:13.379Z
- 近 30 天下载量：2543（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

bgc——统一交易账户(UTA / v3)API的官方Bitget shell CLI. 通过意向动词,从终端或空壳式AI助手(Claude Code, Codex CLI, OpenClaw)驱动市场数据,交易,职位,账户,资金,贷款和税收,

## 安装

```sh
npm install @bitget-ai/bitget-agent-cli
```

也可以使用：`pnpm add @bitget-ai/bitget-agent-cli`、`yarn add @bitget-ai/bitget-agent-cli`、`bun add @bitget-ai/bitget-agent-cli`

## README

# `bgc` ——Bitget的代理本地CLI

#### `@bitget-ai/bitget-agent-cli`

[![npm](https://img.shields.io/npm/v/%40bitget-ai%2Fbitget-agent-cli.svg?style=flat-square&color=0070f3)](https://www.npmjs.com/package/@bitget-ai/bitget-agent-cli) [![Node.js](https://img.shields.io/badge/Node.js-%E2%89%A520-026e00?style=flat-square)](https://nodejs.org/) [![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://npmcn.com/package/%40bitget-ai/bitget-agent-cli/LICENSE)

这个 **外壳表面** 会 议 日 程 和 议 程 [位元代理 Hub](https://github.com/Bitget-AI/agent-hub) - 一个 **代理第一个** bitget 的命令行 **统一交易账户(UTA/v3)** API (英语).

大多数CLI都是为人类而建的,只是容忍自动化. `bgc` 以相反的方式构建: **AI助手从外壳里驾驶它** (Claude Code, Codex CLI, OpenClaw),由人阅读结果. 一小组 **意图动词**页:1 **自定义表面** 代理在运行时探索,以及 **确定性书写安全** 这样就能安全地把钥匙交给一个自主的特工.

```bash
npm install -g @bitget-ai/bitget-agent-cli
```

二进制是 **`bgc`**。 。 。 .

> **为什么 `npm install -g` 没有 `npx`? 吗?** `bgc` -你的人工智能助理每场都叫几十次 所以你们想开机 `$PATH` 零拨头费。 其它Bitget AI软件包(`@bitget-ai/bitget-agent-skill`, (中文(简体) ), `@bitget-ai/bitget-signal`, (中文(简体) ), `@bitget-ai/bitget-agent-mcp`, (中文(简体) ), `@bitget-ai/bitget-agent-installer`)是一发或子进程发射的,因此它们使用 `npx`。 。 。 .

> **先决条件:** 节点.js 20. 密钥和密码句( B)[创建一个](https://www.bitget.com/api-doc/common/intro)——只针对私人(账户/交易)电话;市场数据公开.

* * *

## 为什么是经纪人?

| AI探员需要什么 | 怎么样 `bgc` 接电话 |
| --- | --- |
| **运行时学习 API** —— LLM不能读取您的文档,100操作目录将不符合其上下文 | **逐步披露** 通过 `discover`: 钻入域 \* 动词 \* 动作 \* 精确参数, 仅装入任务需要的切片 |
| **一个表面,它可以解释** | **14个意图动词** (单位:千美元)`order`, (中文(简体) ), `position`, (中文(简体) ), `market`...) 地图去 _你想怎样_; 100 + 原始操作保持一个 `raw` 编号 : `--full` 离开 |
| **呼叫它可以组装而不用猜测** | 每个参数 **类型、 enum、 auth 和 已读/ 写出旗帜为可查询的活** 没有手持的图谋可以从SDK漂出 |
| **未注意运行时的安全性** | **决定性的大门** —— 说 `--dry-run`, (中文(简体) ), `--read-only`, (中文(简体) ), `--confirm`, (中文(简体) ), `--paper-trading` 是纯正的旗帜, 没有交互提示 |
| **输出程序可以解析** | **Unix- clean I/O 单打** ——JSON出局结果(出局) `0`), stderr上的结构错误(退出) `1`; 管道为 `jq`,退出代码上的分支 |

其余的读取器则在每一个上扩展. 初一为心.

* * *

## 逐步披露——核心思想

AI代理有一个有限的上下文窗口. 预装每个Bitget操作 及其参数 浪费预算 并停止 瞬间API 改变. `bgc` 相反,暴露一个 **自定义表面** 特工自上而下地走着,只支付它将要使用的东西:

```
bgc discover                               →  7 domains          market, trade, account, funds, subaccount, loan, tax
bgc discover --domain trade                →  3 verbs            order, position, strategy_order
bgc discover --tool order                  → 10 actions          place, cancel, cancelAll, open, detail, history, …
bgc discover --tool order --action place   →  the exact contract  required + optional params · types · enums · auth · read/write
```

最后一项是支付——一项诉讼的精确、机器可读合同:

```bash
bgc discover --tool order --action place --pretty
```

```jsonc
{
  "tool": "order", "action": "place",
  "operationId": "placeOrder", "method": "POST", "path": "/api/v3/trade/place-order",
  "auth": "private", "isWrite": true,
  "required": [
    { "name": "category",  "type": "string", "enum": ["SPOT","MARGIN","USDT-FUTURES","COIN-FUTURES","USDC-FUTURES"] },
    { "name": "symbol",    "type": "string" },
    { "name": "side",      "type": "string", "enum": ["buy","sell"] },
    { "name": "orderType", "type": "string", "enum": ["limit","market"] },
    { "name": "qty",       "type": "string" }
  ],
  "optional": [
    { "name": "price", "type": "string" },
    { "name": "timeInForce", "type": "string", "enum": ["ioc","fok","gtc","post_only"] },
    { "name": "clientOid", "type": "string" },
    { "name": "takeProfit", "type": "string" }, { "name": "stopLoss", "type": "string" }
    /* … tp/sl trigger & limit params … */
  ]
}
```

有了这个,特工就直接把电话召集起来 同一只骆驼 大小写字段名称, 没有翻译层 :

```bash
bgc order --action place --category SPOT --symbol BTCUSDT \
    --side buy --orderType market --qty 0.001 --dry-run
```

有两个属性使这特别适用于特工:

-   **自为道行.** 每个 `discover` 答复中包含 `hint` 字段,用于命名下一个 rung,所以一个代理 _零_ 以前的知识可以从 `bgc discover` 一个人.
-   **零取来.** 被披露的"计划"是从SDK的活出——这个回放中没有静态的目录可以脱离同步. 什麽 `discover` 说,通过建筑, 正是CLI的工作.

而当特工只有模糊的想法时,它可以搜索整个地表:

```bash
bgc discover --search funding
# → matches: market (actions: fundingRate, fundingRateHistory), account_overview, …
```

* * *

## 快开始

```bash
export BITGET_API_KEY=...
export BITGET_SECRET_KEY=...
export BITGET_PASSPHRASE=...

# Public market data — no auth needed
bgc market --action tickers --category SPOT --symbol BTCUSDT

# Authenticated read — one-call account snapshot
bgc account_overview --coin USDT

# Preview a write without sending it (nothing leaves the process)
bgc order --action place --category SPOT --symbol BTCUSDT \
    --side buy --orderType market --qty 0.001 --dry-run

# Authenticated write — [CAUTION] real order
bgc order --action place --category SPOT --symbol BTCUSDT \
    --side buy --orderType market --qty 0.001

# Destructive write — high-risk, refuses to run without --confirm
bgc order --action cancelAll --category SPOT --symbol BTCUSDT --confirm

# Pretty-print JSON for human eyes
bgc --pretty position --action info --category USDT-FUTURES
```

* * *

## 语法

```
bgc <tool> [--action <name>] [--<param> <value> ...] [global flags]
bgc discover [--domain <d> | --tool <t> [--action <a>] | --search <q>]
bgc raw --operationId <id> [--args '<json>']
```

-   **`<tool>`** 是一个 **意图动词** (单位:千美元)`market`, (中文(简体) ), `order`, (中文(简体) ), `position`,.),元工具之一 `discover` 编号 : `raw`,或——与 `--full` ——任何1:1生成的操作.
-   **`--action <name>`** 选择动作序动词上的动作(例如:. `order --action place`, (中文(简体) ), `order --action cancelAll`并转至SDK逐字记录`account_overview`, (中文(简体) ), `discover`,以及 `raw` 带不 `--action`. ) (中文(简体) )
-   **商业段落** 使用 SDK 的精确度 **骆驼 Case** 字段名称 : `--symbol BTCUSDT --side buy --orderType market --qty 0.001`价值观自然受到胁迫—— `true`编号 :`false` ~布尔,一个从 `[`编号 :`{` • 解析JSON(例如:. `--orders '[{...}]'`),其他一切都保留了字符串(SDK会强制数字,所以数字ID永远不会被错误地打出.

你脑子里从不需要命令参考 `bgc discover` _实值_ 参考文献,它不能停止.

* * *

## `raw` - 逃生舱门

14个动词为共同操作前作. 当你需要的时候,他们不会... 或者你已经知道确切的.. `operationId` - 直接打电话:

```bash
bgc raw --operationId getTickers --args '{"category":"SPOT","symbol":"BTCUSDT"}'
```

降入1:1平面(100+生成操作) `--full` 当你想要将每个操作作为自己的工具曝光时.

* * *

## 书写安全

`bgc` 继承 SDK 的分层写安全门 。 每个安全决定都会发生 **在此之前** 任何请求都会离开进程,每个控制都是一面决定性的旗帜——没有交互的即时——所以在无人注意和AI驱动的弹壳中它是安全的.

| 控制权 | 效果 |
| --- | --- |
| `--dry-run` | 预览写入并返回精确的有效载荷 _将_ 发送日期(`data.dryRun: true`) (中文(简体) ). 没有网络通话. |
| `--read-only` | 校正时屏蔽每个写入——写动词返回 a `ValidationError` 永远无法到达网络. |
| `--confirm` | 所需经费 **破坏性/高风险** 动作`order --action cancelAll`, (中文(简体) ), `position --action closeAll`, (中文(简体) ), `withdraw --action submit`(中文(简体) ). 没有它,调用回来 `data.confirmationRequired: true` 却一无所为. |
| `--paper-trading` | 路由写到Bitget的演示环境(需要演示证书). 相互独占 `--read-only`。 。 。 . |

```bash
# Dry-run: see what would be sent, send nothing
bgc order --action place --category SPOT --symbol BTCUSDT \
    --side buy --orderType market --qty 0.001 --dry-run

# Read-only: writes are refused before the network
bgc --read-only order --action place --category SPOT --symbol BTCUSDT --side buy ...
# → ValidationError: Operation "placeOrder" is a write and readOnly mode is enabled.

# High-risk gate: cancelAll does nothing until you confirm
bgc order --action cancelAll --category SPOT --symbol BTCUSDT
# → { data: { confirmationRequired: true, ... } }     (stdout, exit 0 — not an error)
bgc order --action cancelAll --category SPOT --symbol BTCUSDT --confirm
# → executes
```

* * *

## 产出合同

-   **成绩** - 解决了 `ToolResult` (单位:千美元)`{ endpoint, requestTime, data }`打印到 **静态**; 退出代码 `0`。 。 。 . `dryRun` 预览和 `confirmationRequired` 闸口为正常结果(出站、出站) `0`这些都不是错误.
-   **失败** • 结构化出错的有效载荷(`{ ok: false, error: { type, category, message, suggestion, retryable }, timestamp }`打印到 **标准**; 退出代码 `1`。 。 。 .

成功输出为压缩 JSON( 添加) `--pretty` 2- 空间缩进); 出错的有效载荷总是相当的打印. 拆分为 unix- clean: 管道 stdout to `jq`,退出代码上的分支,读作 `error.retryable` 决定是否退后再试.

* * *

## 配置

### 全球旗帜

```
--action <name>    Action for an action-routed verb (forwarded as the tool's action)
--modules <list>   Modules to enable (default: all to-C modules); name a hidden one, e.g. --modules broker
--surface <mode>   intent (default) | full (also expose the 1:1 generated operations)
--full             Shorthand for --surface full
--read-only        Block all writes (mutually exclusive with --paper-trading)
--paper-trading    Route writes to the Bitget demo environment (needs demo credentials)
--dry-run          Preview a write without sending it (maps to dryRun)
--confirm          Required to execute destructive (high-risk) writes
--base-url <url>   Override API base URL (else BITGET_API_BASE_URL)
--timeout <ms>     Per-request timeout in ms (else BITGET_TIMEOUT_MS, default 15000)
--pretty           Pretty-print JSON output
--help             Show this help (verb list derived live from the SDK)
--version          Show version
```

### 环境变量

```
BITGET_API_KEY        API key      ┐
BITGET_SECRET_KEY     API secret   ├─ required only for private (account / trade) calls
BITGET_PASSPHRASE     passphrase   ┘
BITGET_API_BASE_URL   override the API base URL (else --base-url, else Bitget default)
BITGET_TIMEOUT_MS     per-request timeout in ms (else --timeout, default 15000)
```

证书只从环境中读取——从不登录,从不写入磁盘.

* * *

## 直视动词

默认( E)`intent`表面暴露 **14个意图动词** 纵横 **7个域** - 13项是按行动路线进行的(选择行动方式是: `--action`),加上单发 `account_overview` - 与 `discover` 编号 : `raw` 元工具 :

| 域名 | 动词 | 认证 |
| --- | --- | :-: |
| `market` | `market` | 公开 |
| `trade` | `order`, (中文(简体) ), `position`, (中文(简体) ), `strategy_order` | 私营 |
| `account` | `account_overview`, (中文(简体) ), `account_config`, (中文(简体) ), `repayment` | 私营 |
| `funds` | `transfer_funds`, (中文(简体) ), `deposit`, (中文(简体) ), `withdraw`, (中文(简体) ), `funds_records` | 私营 |
| `subaccount` | `subaccount` | 私营 |
| `loan` | `loan` | 私营 |
| `tax` | `tax` | 私营 |

每个行动路线动词的前沿 几个基本的操作通过 `--action`。隐藏的经纪人/机构贷款模块是选入(`--modules broker`, (中文(简体) ), `--modules inst_loan`) (中文(简体) ). 电力用户可以掉到 **`--full`** 表面以直接调用生成的 100+ 的 1: 1 操作 .

这里没有手持的目录可以漂移 浏览它所有的生活 `bgc discover`。 。 。 .

* * *

## 怎么样 `bgc` 已构建

`bgc` 是个瘦子, **零业务逻辑** 外壳包装器 [位元代理 SDK](https://github.com/Bitget-AI/agent-sdk)所有路线、验证、写作安全、正常化——以及发现本身——都生活在SDK中。 CLI 只解析 argv, 构建配置的表面, 转发调用, 并打印结果 :

```
bgc CLI  (argv → tool call → JSON on stdout / error on stderr)
   │
   ▼
@bitget-ai/bitget-agent-sdk  (intent verbs, action dispatch, progressive
   │                          discovery, write-safety, REST client, HMAC
   │                          signing, rate limiting)
   ▼
Bitget UTA (v3) REST API
```

由于发现和安全逻辑活在了SDK中,CLI接取了免费的新操作,参数和出入口——一个光谱变化体现在: `bgc discover` 这里没有代码更改。 每个命令会翻译为单个签名的HTTPS请求. 没有遥测,没有代理,没有远程依赖.

* * *

## 何处 `bgc` 符合

`bgc` 存在所以 AI 助手 **已经活在你的外壳里** ——克洛德代码(Claude Code),Codex CLI,OpenClaw——在没有额外集成接线的情况下可以驱动Bitget. LLM写道: `bgc …` 命令,炮弹运行它, JSON 回来.

-   **说MCP?** (Claude桌面、光标、继续、ChatGPT桌面、Windsurf) [`@bitget-ai/bitget-agent-mcp`](https://github.com/Bitget-AI/agent-mcp) 相同意图表面,MCP-形状.
    
-   **让你的助手知道 _何时_ 要达到 `bgc`** 没有教它每个命令? 安装 [Bitget 代理技能](https://github.com/Bitget-AI/agent-skill) 顶部 :
    
    ```bash
    npx @bitget-ai/bitget-agent-skill
    ```
    
    那就说 _"在Bitget市场购买0.1 BTC"_ 或者说 _"展示我开放的未来位置"_ 和它组成 右 `bgc` 引证.
    

* * *

## 警卫

-   证书只从环境变量读取——从不登录,从不写入磁盘.
-   所有经认证的请求均与 **HMAC-SHA256 (韩语)** 正在处理中.
-   客户端利率限制可以防止意外的AI回路打入Bitget的API限制.
-   写作由 `--dry-run` 编号 : `--read-only` 编号 : `--confirm`; 破坏性(高风险)行动在没有明确情况下拒绝运行 `--confirm`。 。 。 .
-   `--read-only` 财务报告和审定财务报表 `--paper-trading` 是分层安全网,用于将CLI交给AI代理.

* * *

## 许可证

[麻省理工学院](https://npmcn.com/package/%40bitget-ai/bitget-agent-cli/LICENSE)

* * *

部分 **[位元代理 Hub](https://github.com/Bitget-AI/agent-hub)** · 贸易堆积.  
基金会: [代理服务器](https://github.com/Bitget-AI/agent-sdk) 其他地表: [代理服务器- mcp](https://github.com/Bitget-AI/agent-mcp) • 妇女 [代理技能](https://github.com/Bitget-AI/agent-skill) 市场信号: [位元符号](https://github.com/Bitget-AI/bitget-signal)

## 常见问题

### @bitget-ai/bitget-agent-cli 是什么？

bgc——统一交易账户\(UTA / v3\)API的官方Bitget shell CLI\. 通过意向动词,从终端或空壳式AI助手\(Claude Code, Codex CLI, OpenClaw\)驱动市场数据,交易,职位,账户,资金,贷款和税收,

### 如何安装 @bitget-ai/bitget-agent-cli？

在项目目录运行 npm install @bitget-ai/bitget-agent-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 bgc，可以用 npx bgc 直接运行。

### @bitget-ai/bitget-agent-cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bitget-ai/bitget-agent-cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bitget-ai/bitget-agent-cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bitget-ai/bitget-agent-cli 可以商用吗？

@bitget-ai/bitget-agent-cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bitget-ai/bitget-agent-cli 的下载量有多少？

根据 npm 官方下载统计，@bitget-ai/bitget-agent-cli 在 2026/10/08 – 2026/11/06 这 30 天内被下载 2,543 次，日均约 85 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bitget-ai/bitget-agent-cli 还在维护吗？

最新版本 3\.0\.0 发布于 2026/06/22（4 个月前）；至今共发布 2 个版本，其中过去 12 个月发布了 2 个；首次发布于 2026/06/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。