# @aptos-labs/aptos-cli 中文文档

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

版本：3\.0\.1
npm 元数据更新时间：2026-10-16T18:21:59.837Z
中文译文更新时间：2026-11-06T13:01:15.286Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：104 kB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.12\.0
- 运行依赖：1 个
- 首次发布：2023-08-23T18:56:14.358Z
- 最新版本发布：2026-10-16T18:21:59.514Z
- 近 30 天下载量：615294（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 4 个）

## 中文简介

可从 npmjs 获取 APTOS CLI

## 安装

```sh
npm install @aptos-labs/aptos-cli
```

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

## README

# Aptos CLI 软件

这个 `@aptos-labs/aptos-cli` 软件包允许您使用 Aptos CLI `Nodejs` 项目.

## 下载

要安装 Aptos CLI, 您需要在您的系统中安装节点和npm 。 然后,你可以使用:

```bash
npm install @aptos-labs/aptos-cli
```

该命令将下载 Aptos CLI 并创建一个节点本文件,使其可用于节点环境.

## 安装

一旦安装了软件包和节点本文件,您就可以在您的项目环境中运行以下命令,以便在您的项目中安装 Aptos CLI :

```bash
npx aptos --install
```

或者,你可以简单地使用 `npx aptos` 命令。 这将安装 Aptos CLI 在您的项目中, 如果它还没有安装的话 .

```bash
npx aptos
```

## 使用量

在您的项目环境中使用 Aptos CLI 运行 `npx aptos` 命令,以查看可用的命令.

```bash
npx aptos
```

折叠器专用旗等 `--install`, (中文(简体) ), `--update`, (中文(简体) ), `--binary-path`,以及 `--direct-download` 由节点CLI包装器处理。 其他参数被转发到Aptos CLI 二进制,当二进制需要作为同一引用的一部分被安装时,此二进制也起作用. 例如:

```bash
npx aptos --help
```

```bash
npx aptos move compile --package-dir ./my-move-package
```

### 使用自定义二进制

如果您的系统中已经安装了 Aptos CLI 二进制, 您可以指定其路径直接使用 :

```bash
npx aptos --binary-path /path/to/aptos <command>
```

### 安装特定版本

您可以通过设置 Aptos 的 CLI 安装特定版本 `APTOS_CLI_VERSION` 环境变量 :

```bash
# Install version 4.5.0
APTOS_CLI_VERSION=4.5.0 npx aptos --install

# Or with the v prefix
APTOS_CLI_VERSION=v4.5.0 npx aptos --install
```

何时 `APTOS_CLI_VERSION` 设置为:

-   指定的版本直接从 GitHub 版本下载( 包管理器被绕过)
-   该版本经过验证以确保在下载前存在
-   这对双方都有用 `--install` 财务报告和审定财务报表 `--update` 命令

这对于:

-   连接到已知的工作版本
-   对照特定CLI版本进行测试
-   CI/CD管道的可复制建筑

## 更新 Aptos 的 CLI

要更新 Aptos CLI, 您可以在您的工程环境中运行以下命令 :

```bash
npx aptos --update
```

## 发展

设立发展项目:

1.  清除仓库
2.  安装依赖性 :
    
    ```bash
    npm install
    ```
    
3.  运行开发服务器 :
    
    ```bash
    npm run dev
    ```
    

这将构建项目并运行CLI.

## 大楼

为建设该项目:

```bash
npm run build
```

## 移动 CI/CD 中的艺术

Aptos CLI可用于CI/CD管道来构建Move套件并生成部署有效载荷. 这对于自动化部署和多步骤工作流程是有用的.

### 示例: 构建发布有效载荷

```yaml
# In your GitHub Actions workflow

# Prerequisites: Set up Node.js first
- name: Setup Node.js
  uses: actions/setup-node@v4
  with:
    node-version: "22"

- name: Install Aptos CLI npm package
  run: npm install @aptos-labs/aptos-cli

- name: Install Aptos CLI
  run: npx aptos --install

- name: Build Move package
  working-directory: your-move-project
  run: |
    ~/.local/bin/aptos move compile \
      --named-addresses your_module=0x1 \
      --save-metadata

- name: Generate publish payload
  working-directory: your-move-project
  run: |
    ~/.local/bin/aptos move build-publish-payload \
      --named-addresses your_module=0x1 \
      --json-output-file publish-payload.json \
      --assume-yes

- name: Upload artifact for later steps
  uses: actions/upload-artifact@v4
  with:
    name: move-artifacts
    path: your-move-project/publish-payload.json
```

### 实例:建筑物升级有效载荷(目标代码部署)

为更新现有标的物合同:

```yaml
- name: Generate upgrade payload
  working-directory: your-move-project
  run: |
    ~/.local/bin/aptos move build-upgrade-payload \
      --named-addresses your_module=0x1 \
      --object-address 0xYOUR_OBJECT_ADDRESS \
      --json-output-file upgrade-payload.json \
      --assume-yes
```

### 在以后的作业中使用艺术

```yaml
jobs:
  build:
    runs-on: 4cpu-gh-ubuntu24-x64
    steps:
      # ... build steps above ...
      - uses: actions/upload-artifact@v4
        with:
          name: move-artifacts
          path: your-move-project/publish-payload.json

  deploy:
    needs: build
    runs-on: 4cpu-gh-ubuntu24-x64
    steps:
      - uses: actions/download-artifact@v4
        with:
          name: move-artifacts

      - name: Use the payload
        run: |
          # The payload JSON can be used for deployment
          cat publish-payload.json
```

见 [建设-移动-艺术. yaml](https://npmcn.com/package/%40aptos-labs/aptos-cli/.github/workflows/build-move-artifacts.yaml) 完整工作实例的工作流程.

## 常见问题

### @aptos-labs/aptos-cli 是什么？

可从 npmjs 获取 APTOS CLI

### 如何安装 @aptos-labs/aptos-cli？

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

### @aptos-labs/aptos-cli 支持 TypeScript 吗？

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

### @aptos-labs/aptos-cli 支持 ESM 还是 CommonJS？

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

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

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

### @aptos-labs/aptos-cli 可以商用吗？

@aptos-labs/aptos-cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aptos-labs/aptos-cli 的下载量有多少？

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

### @aptos-labs/aptos-cli 还在维护吗？

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