@augustdigital/cli

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

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

安装

npm install -g @augustdigital/cli

或者不安装就运行 :

npx -y @augustdigital/cli --help

快速启动

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 永远 胜过会话.

全球旗帜

图标

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

默认名称

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

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分钟——地址总是在没有网络呼叫的情况下工作.

食谱

# 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 服务器 :

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

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

JSON 信封

每个 --json 响应使用相同的信封 @augustdigital/mcp数字 :

{
  "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 ——电文不属于合同内容.

程序使用

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

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

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

退出代码

监视模式

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