# @augustdigital/cli 中文文档

规范地址：https://npmcn.com/package/%40augustdigital/cli/

版本：4\.13\.51
npm 元数据更新时间：2026-10-28T14:17:20.766Z
中文译文更新时间：2026-11-07T04:46:00.230Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：118 kB，50 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.23\.4 \<23\.0\.0 \|\| \>=24\.22\.1 \<25\.0\.0 \|\| \>=26\.12\.1
- 运行依赖：8 个
- 首次发布：2025-10-07T07:26:55.887Z
- 最新版本发布：2026-10-28T14:17:20.530Z
- 近 30 天下载量：3597（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：110（近 12 个月 79 个）

## 中文简介

CLI为"八月"数字生态系统提供动力.

## 安装

```sh
npm install @augustdigital/cli
```

也可以使用：`pnpm add @augustdigital/cli`、`yarn add @augustdigital/cli`、`bun add @augustdigital/cli`

## README

# `@augustdigital/cli`

这个 `august` 命令 – 仅读取的 CLI 相对于 August Digital SDK. 检查金库 APY、TVL、位置、救赎和用户点 EVM,索拉纳,和Stellar 不写 TypeScript.

设计时只读. 没有签名或写入命令 .

## 安装

```sh
npm install -g @augustdigital/cli
```

或者不安装就运行 :

```sh
npx -y @augustdigital/cli --help
```

## 快速启动

```sh
august init                              # one-time setup
august whoami                            # confirm config + API key status
august vault apy 0xVault --chain 8453    # current APY (human output)
august vault apy eth-coreusdc            # same call, by name
august vault apy 0xVault --chain 8453 --json | jq .data.currentApy
```

## 配置布局

`august init` 写道:

```
~/.augustdigital/
├── config.json    # default chain, RPCs, profile, telemetry
├── keystore.json  # AES-256-GCM; holds your August API key (optional)
├── .session       # mode 0600; decrypted API key + expiry
└── profiles/      # named overlays for chain + RPC sets
```

覆盖根 `AUGUST_CONFIG_DIR=…`。 。 。 .

## 认证

如果您在期间存储了 API 密钥 `init`运行 `august login` 单次 打开密钥的外壳 。 随后的命令读取自 `.session` 直至到期( 默认 1h, set) `config.auth.sessionTtlSec`) (中文(简体) ). `august logout` 释出.

在CI中,两套 `AUGUST_PASSPHRASE` (这样) `login` 非交互运行) 或完全跳过密钥并使用 `AUGUST_API_KEY`. Env vars 永远 胜过会话.

## 全球旗帜

| 旗帜 | 目的 |
| --- | --- |
| `--json` | 稳定JSON的信封在Stdout上. |
| `--csv` | CSV输出(只有表格命令). |
| `--chain <id>` | 连锁ID为这个电话. |
| `--rpc <url>` | RPC URL 覆盖 `--chain`) (中文(简体) ). |
| `--profile <name>` | 要激活的命名配置文件 . |
| `--no-color` | 禁用 ANSI 颜色 . |
| `--verbose` | 医生的诊断. |
| `--config-dir <path>` | 覆盖 `~/.augustdigital` 为这个电话. |

## 图标

| 组 | 命令 |
| --- | --- |
| 设置 | `init`, (中文(简体) ), `login`, (中文(简体) ), `logout`, (中文(简体) ), `whoami` |
| 配置 | `config get|set|list|path` |
| 简介 | `profile create|switch|list|delete` |
| 诊断 | `chain list`, (中文(简体) ), `rpc test [--chain <id>]` |
| 默认 | `vault list|get|apy|tvl|positions|loans|allocations|redemptions|history|summary` |
| 用户 | `user points|positions|pnl --vault <addr-or-name>` |
| 技能 | `skill install|path` |

运行 `august <command> --help` 每个命令的标记和示例.

## 默认名称

每一个命令 `<vault>` (和 `user pnl --vault …`接受 原始地址或金库名称:

```sh
august vault list                           # discover known names per chain
august vault tvl coreusdc                   # bare symbol, chain inferred
august vault tvl eth-coreusdc               # explicit chain prefix
august vault tvl 0xE9B7…32 --chain 1        # raw address (unchanged)
```

已接受链前缀 : `eth`编号 :`mainnet`, (中文(简体) ), `base`, (中文(简体) ), `arb`编号 :`arbitrum`, (中文(简体) ), `op`编号 :`optimism`, (中文(简体) ), `avax`编号 :`avalanche`, (中文(简体) ), `bsc`编号 :`bnb`, (中文(简体) ), `polygon`编号 :`matic`, (中文(简体) ), `hyperevm`编号 :`hyper`, (中文(简体) ), `monad`, (中文(简体) ), `mezo`, (中文(简体) ), `plasma`, (中文(简体) ), `ink`, (中文(简体) ), `flare`。 。 。 .

如果一个赤名匹配多个链条, CLI 返回 `VAULT_NAME_AMBIGUOUS`; 名称前缀或通过 `--chain`。 。 。 . 名称来自上行元数据端点并被缓存 10分钟——地址总是在没有网络呼叫的情况下工作.

## 食谱

```sh
# Inspect a vault
august vault summary 0xVault --chain 8453
august vault apy 0xVault --chain 8453 --json | jq .data.currentApy

# Wallet's positions across all August vaults
august user positions 0xWallet --json \
  | jq '.data.positions[] | {vault, chainId, shares}'

# Lifetime PnL for a wallet in one vault
august user pnl 0xWallet --vault 0xVault --chain 1

# Diagnose a flaky RPC
august rpc test --json

# Per-call RPC override (no config change)
AUGUST_RPC_8453=https://my-rpc.example/v1 august vault tvl 0xVault --chain 8453

# Environment-specific config
august profile create staging --chain 8453
august profile switch staging
august config set rpcs.8453 https://staging-rpc.example/v1
```

## Claude 代码技能

有克洛德密码技能的船 教克洛德怎么叫CLI 和伴奏的 MCP 服务器 :

```sh
august skill install
# → ~/.claude/skills/august.md
```

覆盖目的地 `--dest <dir>` (或 `CLAUDE_SKILLS_DIR`) (中文(简体) ). 过 `--force` 以覆盖不同的文件.

## JSON 信封

每个 `--json` 响应使用相同的信封 [`@augustdigital/mcp`](https://npmcn.com/package/%40augustdigital/mcp)数字 :

```json
{
  "schemaVersion": 1,
  "command": "vault.apy",
  "ok": true,
  "data": { "address": "0x…", "chainId": 8453, "currentApy": 0.1234 },
  "meta": { "chainId": 8453, "durationMs": 312, "generatedAt": "2026-05-17T…" }
}
```

失败时 : `ok: false`, (中文(简体) ), `error: { code, message, remediation? }`匹配 打开 `error.code` ——电文不属于合同内容.

## 程序使用

```ts
import { buildProgram } from '@augustdigital/cli';

const program = buildProgram();
await program.parseAsync(['node', 'august', 'whoami', '--json']);
```

`buildProgram()` 返回二进制所用的同一指针树,所以 嵌入器(测试、MCP服务器、内部工具)可以驱动 CLI 不产下一个孩子的过程.

## 退出代码

| 代码 | 含义 |
| --- | --- |
| 0 个 | 成功——以及未来 `ops` 命令,没有异常. |
| 1个 | 执行错误( 错误输入, 网络失败, 未解决的金库) 。 这个 `--json` 信封携带 `error.code` + 键 `remediation`。 。 。 . |
| 2个 | `ops health` 编号 : `ops redemptions` 已完成但发现异常情况`data.anomalies > 0`Cron在非零出入口进入警戒状态. |

## 监视模式

`points leaderboard`, (中文(简体) ), `vault pending-redemptions`, (中文(简体) ), `ops health`,以及 `ops redemptions` 接受 `--watch <seconds>`. 人类产出在 地点; `--json` 每分拨发送一个信封(NDJSON)用于管道.

## 常见问题

### @augustdigital/cli 是什么？

CLI为"八月"数字生态系统提供动力\.

### 如何安装 @augustdigital/cli？

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

### @augustdigital/cli 支持 TypeScript 吗？

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

### @augustdigital/cli 支持 ESM 还是 CommonJS？

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

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

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

### @augustdigital/cli 可以商用吗？

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

### @augustdigital/cli 的下载量有多少？

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

### @augustdigital/cli 还在维护吗？

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