# @amplitude/developer-cli 中文文档

规范地址：https://npmcn.com/package/%40amplitude/developer-cli/

版本：0\.7\.0
npm 元数据更新时间：2026-11-04T23:29:22.820Z
中文译文更新时间：2026-11-06T20:17:07.349Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40amplitude/developer-cli
原文对照：https://npmcn.com/package/%40amplitude/developer-cli/?lang=original
项目主页：https://github.com/amplitude/developer-cli#readme
源码仓库：https://github.com/amplitude/developer-cli

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

- 包体积（解压后）：1.8 MB，78 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：^22\.13\.0 \|\| \>=23\.5\.0
- 运行依赖：9 个
- 首次发布：2026-06-26T17:14:42.947Z
- 最新版本发布：2026-11-04T23:29:22.482Z
- 近 30 天下载量：2386（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

aMP CLI 和开发者通过开发者 API 来管理振幅平台原始的工艺品

## 安装

```sh
npm install @amplitude/developer-cli
```

也可以使用：`pnpm add @amplitude/developer-cli`、`yarn add @amplitude/developer-cli`、`bun add @amplitude/developer-cli`

## README

# @amplitude/developer-cli (英语)

CLI 和开发商的文物 [高度开发者 API](https://developer-api.amplitude.com/)。 。 。 .

`amp` 管理一等站台原始(项目、分类学和 特性标记)通过开发者 API. 相关国家领导机构:

-   `ampli` ——仪器和打入的SDK代码源
-   `amplitude-wizard` ——入职和设置

## 设计原则

这些指导每一次对CLI的修改(见 [一般事务人员(其他职等)](https://npmcn.com/package/%40amplitude/developer-cli/AGENTS.md) 全文 版本 :

1.  **很明显,默认.** 最好的表面不需要解释——可以发现 帮助, 一致的动词, 安全的默认, 和错误, 告诉你该怎么做 下一个.
2.  **代码是营销.** 这个来源是公开的,它的组织是为了清晰, 具有小型单一用途模块、熟悉的命名和计划验证 投入.
3.  **测试缝合那重要.** 纯逻辑测试单位 安全关键路径(自动优先、破坏行动确认、, 证书授权)被明确涵盖.
4.  **两个读者:人类和特工.** 交互式产出能最大限度地提高能见度 可读性(表、摘要);管式输出为紧凑和无损失 (最小字符)所以代理商不支付装饰费.

## 安装

```bash
npm install -g @amplitude/developer-cli
amp help
```

或者不安装就运行 :

```bash
npx @amplitude/developer-cli help
```

## 认证

运行 `amp auth login` 通过 OAuth 设备流认证。 奥米 `--profile` 和CLI针对活性剖面,或 `default` 当没有的时候 活动。 选择一个区域时要明确:

```bash
amp auth login --region us                       # device flow → "default" profile
amp auth status                                  # active credential, type, expiry
amp context
```

配置文件将证书绑定在一个区域(它) `base_url`),所以欧盟的标志可以 从来没有被送到prod。 当您想要多个时, 明确命名 :

```bash
amp auth login --profile eu --region eu          # activates the EU profile
amp auth use prod                                 # switch back (no re-auth)
amp auth list                                     # * marks the active profile
amp logout --profile eu                           # remove one
amp logout --all                                   # remove every profile
```

一个赤裸的 `amp auth login` 重新校正当前活动的配置 。 简介 保存到 `~/.amplitude/amp/credentials.json` (0600) (中文(简体) ).

### 注册

创建一个有明确输入的账户。 通过使用此命令,你同意 页:1 [服务条件](https://amplitude.com/terms) 并承认 [隐私政策](https://amplitude.com/privacy) 适用.

```bash
amp auth signup \
  --email alex@example.com \
  --full-name "Alex Morgan" \
  --region us \
  --accept-tos
```

`--non-interactive` 跳过浏览器交互并等待授权. `--json` 控制输出格式;管输出为紧凑的JSON.

`--accept-tos` 通过服务条款和隐私政策 URL 注册请求.

| 状态 | 含义 | 退出 |
| --- | --- | --- |
| `authorized` | 证书保存; profile 活动 。 托肯斯留在当地. | `0` |
| `requires_auth` | 需要浏览器授权 。 挑战已保存; 使用返回的投票命令 . | `0` |
| `needs_information` | 毫无名气的要求随着他们完整的计划和支持的旗帜绘图而回归. | `2` |

检查 `status` 发布认证命令前: 退出 `0` 意思是说 仍然需要批准。 续作包括可读命令 和参数数组 :

```bash
amp auth login poll --profile default --json
```

见 `amp auth login poll --help` 投票选择.

配置文件遵循登录规则: 选择 `--profile`,否则活动简介, 否则 `default`。注册需要明确 `--region`成功注册 端点更新其身份. 改变它的终点需要 `--force`。 。 。 . 现有证书和启用 保留到认证成功并保存替换,包括 当注册返回一个待定的挑战时.

喜欢个人访问Token? `amp auth pat --with-token --region <us|eu>` 读取 PAT from stdin(或一个在终端的被遮住的提示)并保存为剖面图—— `--profile` 选项( 默认为 `default`)),同"武力-解释"创造规则, 同一个商店. `--with-token` 需要时间.

```bash
echo "$PAT" | amp auth pat --with-token --region us
```

对于 CI 或 一次性 shell, 设置一个原始符号 —— 它覆盖存储的配置文件 :

```bash
export AMP_TOKEN=amp_...        # amp_… is treated as a PAT, anything else a bearer
```

`AMP_PROFILE` 按名称选择存储的配置文件; `amp auth token` 打印 活动访问 stdout () 的符号`TOKEN=$(amp auth token)`) (中文(简体) ).

## 实例

```bash
amp context
amp projects list
amp projects api-keys get --project <project_id>
amp events list --project <project_id> --limit 5
amp events create --project <project_id> --event-type my_event --display-name "My Event"
amp flags list --project <project_id> --limit 5
amp flags create --project <project_id> --key my-flag --name "My Flag"
amp flags get --project <project_id> --flag <flag_id>
amp flags archive --project <project_id> --flag <flag_id> --dry-run
amp guides list --project <project_id> --limit 10
amp surveys get --project <project_id> --survey <survey_id> --include-unpublished-changes
amp heatmaps click-map --project <project_id> --page-url https://example.com/pricing
amp zoning zone-metrics --project <project_id> --page-url https://example.com/pricing --metric click_rate_pageview
```

## 项目摄取 API 密钥

探索工程 API- key 命令 `amp projects api-keys --help`,或添加 `--json` 提供结构化帮助.

使用您认证的配置文件获取工程的主要摄取 API 密钥 或提供的令牌 :

```bash
amp projects api-keys get
amp projects api-keys get --project 12345
amp projects api-keys get --project 12345 --json
AMPLITUDE_API_KEY="$(amp projects api-keys get --project 12345 --raw)"
```

在终端上,命令显示工程名称,ID,和完整的密钥. 管道输出 aPI JSON 密钥为 `data.api_key`· ; `--json` 强制 JSON 在任何 环境. `--raw` 只打印新行后面的密钥,不能是 结合 `--json`。 。 。 .

提供正整数项目标识 . `--project-id` 财务报告和审定财务报表 `--project_id` 也为 已接受。 当组织有一个 未删除的项目; 否则使用 `amp projects list` 找到它的身份证.

检索要求 `projects:read` 并允许查看工程的 API 密钥. 命令在不创建、旋转或不创建的情况下检索指定的工程密钥 留着吧 失败会留下 stdout 空出并报告 stderr 上的错误 .

## 吸烟试验

附有证书`amp auth login`,或 `AMP_TOKEN` 设定 :

```bash
pnpm smoke
```

见 [文件/目录](https://npmcn.com/package/%40amplitude/developer-cli/docs/cli.md) 整个烟雾清单和PAT范围说明.

## 常见问题

### @amplitude/developer-cli 是什么？

aMP CLI 和开发者通过开发者 API 来管理振幅平台原始的工艺品

### 如何安装 @amplitude/developer-cli？

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

### @amplitude/developer-cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/amplitude\_\_developer-cli 是否存在。

### @amplitude/developer-cli 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @amplitude/developer-cli 需要什么版本的 Node\.js？

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

### @amplitude/developer-cli 可以商用吗？

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

### @amplitude/developer-cli 的下载量有多少？

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

### @amplitude/developer-cli 还在维护吗？

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