CLI 参考

pikeway keys list

显示本机保存的 key(掩码形式),并标出当前 key。

用法

bash

pikeway keys list [--json]
pikeway keys                      # same as keys list

说明

读取本地配置文件(~/.config/pikeway/config.json,见配置文件),列出所有已保存的标签。key 只显示前 6 位和后 4 位;不超过 12 个字符的 key 显示为 ****。完整的 key 永远不会被打印。

该命令不连接网关,也不检查 key 是否仍然有效;校验请用 pikeway whoami 或 pikeway setup。不带子命令的 keys 等同于 list。

参数

除 --json 外没有其他参数。

示例

bash

pikeway keys list

# which label is active?
pikeway keys list --json | jq -r .active

# use a different config directory (e.g. per project)
XDG_CONFIG_HOME=$PWD/.config pikeway keys list

输出

text

● main  pk-AbC…xYz9
  ci  pk-9fQ…T2mw

● 标出当前 key,即没有 --key 和 PIKEWAY_API_KEY 时使用的 key。
没有保存任何 key 时输出 No keys. Add one: pikeway keys add --label main --key pk-...

--json

json

{
  "active": "main",
  "keys": [
    { "label": "main", "key": "pk-AbC…xYz9" },
    { "label": "ci", "key": "pk-9fQ…T2mw" }
  ]
}

没有保存任何 key 时,active 为 null,keys 为空数组。

错误与退出码

列出操作不会失败:配置文件不存在或无法读取时按空处理。

退出码	错误信息	触发条件
2	unknown: pikeway keys foo (use list \| add \| activate \| remove)	未知子命令。

设置了 PIKEWAY_API_KEY 时,这里显示的当前 key 会被忽略。见 API key 的确定顺序。

同样支持全局参数 -j, --json。见全局参数与退出码。