CLI 参考
pikeway whoami
查看 CLI 正在使用的账户和 key,并确认 key 仍然有效。
用法
bash
pikeway whoami [--json] [--key pk-...]
说明
使用其他命令同样会用到的 key(依次为 --key、PIKEWAY_API_KEY、已保存的当前 key)调用 GET /v1/auth/whoami,输出账户以及 key 的名称和掩码预览。账户优先显示邮箱;没有邮箱时依次显示钱包地址、Twitter 账号或用户 id。
在脚本花钱之前,这是确认 key 有效的最快方法。
参数
除全局参数 --json 和 --key 外没有其他参数。
示例
bash
pikeway whoami # check a key before saving it pikeway whoami --key pk-... # fail a CI job early when the key is bad (exit 3) pikeway whoami -j > /dev/null || exit 1 # remaining key budget pikeway whoami --json | jq '.key.budget'
输出
text
[email protected] key agent pk-AbCd****xYz9 scopes: call, api:birdeye expires: 2026-11-26 budget: $1.2500 of $5 used
第一行是账户、在控制台设置的 key 名称(不是本地标签)及其预览。接着是它的权限(没设置时显示 full access),以及有效期和花费上限(设了才显示)。
--json
json
{
"userId": "cm2x8k1qz0000abcd1234efgh",
"email": "[email protected]",
"walletAddress": null,
"twitterHandle": null,
"key": {
"id": "cm2x9p4rt0001abcd5678ijkl",
"name": "agent",
"preview": "pk-AbCd****xYz9",
"scopes": ["call", "api:birdeye"],
"fullAccess": false,
"expiresAt": "2026-11-26T00:00:00Z",
"budget": { "limit": 5, "used": 1.25, "currency": "USD" }
}
}仅当 key 设置了消费上限时才会出现 key.budget。没设权限的 key,key.scopes 为空、fullAccess 为 true;永不过期时 expiresAt 为 null。
错误与退出码
| 退出码 | 错误信息 | 触发条件 |
|---|---|---|
| 3 | no API key: run `pikeway keys add --label main --key pk-...`, set PIKEWAY_API_KEY, or pass --key | 没有 --key、没有 PIKEWAY_API_KEY,也没有已保存的当前 key。在发出请求之前就会检查。 |
| 3 | invalid or revoked API key — add a key with `pikeway keys add --label main --key pk-...` (or use --x402) | 网关返回 401(key 不存在、已吊销或已过期)。403 同样以 3 退出。 |
| 1 | cannot reach <gateway>: ECONNREFUSED | 无法连接网关(DNS、网络,或 PIKEWAY_API_BASE_URL 写错)。冒号后的错误码来自 Node。 |