@circle-fin/cli

中文文档

1.2.3发布于 2026/11/05Apache-2.0TypeScriptES Module近 30 天下载 2286

Circle CLI — command-line tool for interacting with Circle services.

文档目录18 节

Quickstart
Logout
Check or Create a Wallet
Discover Skills
Commands
Blockchain
Bridge
Contract
Gateway
Services
Transaction
Wallet
Limit
External Wallet
Testnet Funds
Update
Help
Legal

cli

Circle's CLI for setting up an agent wallet, funding it with USDC, and using it for stablecoin-powered workflows.

Learn more at agents.circle.com.

Quickstart

Install the CLI and login.

npm install -g @circle-fin/cli
circle --version
circle wallet login <email>
# Enter the OTP code sent to your email when prompted
circle wallet status

Logout

To clear the current session:

circle wallet logout

Check or Create a Wallet

Check the current wallet state on ARC:

circle wallet list --chain ARC --type agent --output json

The initial agent wallets are provisioned during login. Use circle wallet list first to inspect what is already available.

Create an EVM SCA wallet batch on all supported chains:

circle wallet create
circle wallet create --testnet
circle wallet list --chain ARC --type agent --output json

Check the wallet balance:

circle wallet balance --address <addr> --chain ARC --output json

Discover Skills

Once the wallet is set up, use the CLI to discover other Circle skills:

circle skill list
circle skill info --name use-circle-cli

Install a skill for the current tool:

circle skill install --tool claude-code --name use-circle-cli
# or --tool cursor, --tool codex

Commands

Blockchain

Blockchain commands let you inspect supported chains and configure per-chain RPC settings.

# Inspect blockchain RPC configuration
circle blockchain config --chain ARC
# List supported blockchains
circle blockchain list

Bridge

Bridging moves USDC from one supported blockchain to another with CCTP.

# Show the fee for a bridge route
circle bridge get-fee ARC --chain ARB
# Check the status of a bridge transfer
circle bridge status <burn-tx-hash> --chain ARB
# Bridge USDC from Arbitrum to Arc
circle bridge transfer ARC --amount 1.0 --address <addr> --chain ARB

Contract

Contract queries let you look up Circle contract addresses and read onchain contract state without submitting a transaction.

# Show Circle contract addresses on a chain
circle contract address usdc --chain ARC
# Query read-only contract state
circle contract query "balanceOf(address)" <addr> --contract <contract> --chain ARC --output json

Gateway

Gateway is used for nanopayments, including depositing wallet funds into a Gateway balance and managing that balance.

# Show the current Gateway balance across all settlement chains
circle gateway balance --address <addr> --chain ARC --all
# Deposit wallet USDC directly on Arc
circle gateway deposit --amount 0.5 --address <addr> --chain ARC --method direct
# Deposit wallet USDC into Gateway for nanopayments
circle gateway deposit --amount 0.5 --address <addr> --chain ARB --method eco
# Withdraw funds from Gateway back to a wallet
circle gateway withdraw --amount 0.1 --address <addr> --chain ARC

Services

Services lets you discover paid x402 endpoints, inspect pricing, and estimate or execute paid requests with the wallet.

# Inspect a paid endpoint and its pricing
circle services inspect https://api.example.com/data
# Estimate a paid request before sending it
circle services pay https://api.example.com/data --address <addr> --chain ARC --estimate
# Search for paid x402 services
circle services search "web search"

Transaction

Transaction commands help manage pending transactions after they have been submitted.

# Speed up a pending transaction
circle transaction accelerate <transaction-id> --chain ARC
# Cancel a pending transaction
circle transaction cancel <transaction-id> --chain ARC

Wallet

The wallet flow covers sending USDC, swapping into supported assets, executing onchain actions, and managing spending policy from a wallet address.

# Execute a write call from the wallet
circle wallet execute "approve(address,uint256)" <spender> <amount> --contract <contract> --address <addr> --chain ARC --estimate
# Swap tokens with Circle Stablecoin Kits
circle wallet swap USDC 1.0 EURC 0.8 --address <addr> --chain ARC
# Move ERC-20 USDC between wallets on Arc
circle wallet transfer <recipient> --amount 1 --token 0x3600000000000000000000000000000000000000 --address <addr> --chain ARC

Limit

Limit controls spending policy on an agent wallet, including remaining budget, transfer limits, blocklists, and resetting custom policies. Policy writes require OTP confirmation.

# Show remaining EVM-wide rolling-window policy + budget (daily / weekly / monthly)
circle wallet limit budget --address <addr>
# Set a custom transfer limit — OTP-gated, ephemeral human session
circle wallet limit set --address <addr> --chain ARC \
  --policy-type stablecoin --per-tx 100 --daily 100 --weekly 100 --monthly 100
 # Block specific recipient addresses — OTP-gated
circle wallet limit set --address <addr> --chain ARC \
  --policy-type stablecoin --rule-type recipient-blocklist \
  --targets "[0xBAD1,0xBAD2]"
# Block specific contracts on the contract-execution path — OTP-gated
circle wallet limit set --address <addr> --chain ARC \
  --policy-type contract --rule-type contract-blocklist \
  --targets "[0xCONTRACT]"
# Reset every custom policy on this (wallet, chain) back to defaults — OTP-gated
circle wallet limit reset --address <addr> --chain ARC

External Wallet

Import a local wallet from a private key or mnemonic phrase:

circle wallet import my-wallet --private-key || circle wallet import my-wallet --mnemonic
circle wallet list --chain ARC --type local

Imported local wallets can be used with wallet-based commands such as transfer, contract execution, bridge, and Gateway flows where local wallet support is available.

Testnet Funds

Use a separate testnet login session when you want to try the CLI without using mainnet funds:

circle wallet login <email> --testnet
circle wallet list --chain ARC-TESTNET

Testnet and mainnet sessions are stored separately.

Update

To update to a new version of the CLI, run:

circle update

This checks for a newer published version and, if one is available, prompts before running npm install -g @circle-fin/cli@latest for you. Pass --yes to skip the prompt (useful in scripts and CI). If you'd rather upgrade by hand, the npm command above works directly.

Help

Use --help on any command group to see the full list of supported verbs, flags, and examples.

circle --help
circle wallet --help
circle gateway --help
circle services --help

Legal

By using the Circle CLI, you agree to the Terms of Use and Privacy Policy.

版本与发布记录

@circle-fin/cli 共发布 17 个版本，首次发布于 2026/05/09；过去 12 个月发布了 17 个版本。

版本	发布日期	距今
`1.2.3`latest	2026/11/05	4 天前
`1.2.2`	2026/10/15	25 天前
`1.2.1`	2026/10/10	30 天前
`1.2.0`	2026/10/07	1 个月前
`1.1.4`	2026/09/22	1 个月前
`1.1.3`	2026/09/18	1 个月前

关于 @circle-fin/cli 的常见问题

@circle-fin/cli 是什么？

Circle CLI — command-line tool for interacting with Circle services.

如何安装 @circle-fin/cli？

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

@circle-fin/cli 支持 TypeScript 吗？

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

@circle-fin/cli 支持 ESM 还是 CommonJS？

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

@circle-fin/cli 需要什么版本的 Node.js？

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

@circle-fin/cli 可以商用吗？

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

@circle-fin/cli 的下载量有多少？

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

@circle-fin/cli 还在维护吗？

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