KeysArk
ark CLI

ark CLI 使用文档

在终端里读写你的端到端加密保险库。明文与助记词只留在本地,离开设备的永远只有密文。

这是什么

ark 是 KeysArk 的官方命令行客户端,把网页保险库的能力带到终端:列出条目、按路径读取、保存本地文件、创建与更新条目。所有加解密都在本地用你的助记词完成——服务端与网盘后端全程只经手不透明密文。

安装

@keysark/cli@1.0.7
npm install -g @keysark/cli

需要 Node.js 18+。安装后即可使用 ark(以及别名 keysark)命令。

首次配置

两步:授权这台设备,再导入你的助记词。

ark login

ark login 走设备码授权:终端给出一个链接与代码,在浏览器里核对代码并确认。授权态等同一次浏览器登录,只能搬运密文,拿不到你的助记词或明文。

ark import

ark import 让你输入助记词,并为本机设置一个解锁密码。助记词经 Argon2id 派生密钥加密后存在本地(~/.keysark),绝不上传;解锁缓存连续 5 分钟无操作即失效,期间无需重复输入密码。

命令一览

  • ark login设备码授权这台设备(会打开浏览器核对)。
  • ark import导入助记词并设置本机解锁密码。
  • ark status查看登录与助记词状态。
  • ark info查看版本、服务端来源与配置目录。
  • ark vaults列出账号下的所有保险库,并标注助记词是否匹配。
  • ark ls列出当前保险库里的所有条目。
  • ark get <path|id> [file]按路径或 ID 解密读取条目;不带文件名打印到标准输出,带文件名写入文件。
  • ark save <file> [target]把本地文件(文本或二进制)存进保险库,二进制按文件条目加密存储;在 git 仓库里会按 origin 自动推断目标路径。
  • ark sync [folder]把 vault 文件夹与本地目录按修改时间双向同步(较新的一方覆盖较旧的)。git 仓库里可省略目录,用 origin 匹配;执行前展示方向并确认,保持相对路径。
  • ark reset-anchor [vault]清除某库的回滚保护锚点。仅在你确属有意重置/恢复了该库、且因「index rollback detected」导致读被警告或写被拦时使用;下次载入会以网盘当前版本重新锚定。
  • ark logout清除本机登录态(保留助记词凭据)。
  • ark forget删除本机保存的助记词凭据与解锁缓存。

全局选项

  • --server <url>覆盖服务端地址(默认 https://keysark.com)。
  • --vault <id|label>按 ID 或名称选择保险库(默认取第一个匹配助记词的库)。
  • --no-browser登录时不自动打开浏览器。

常用示例

把一个条目解密写到本地文件:

ark get github.com/me/app/.env .env

在项目目录里把 .env 存进保险库(自动按 git origin 推断路径):

cd ~/my-project
ark save .env

在 CI / 脚本里免交互使用(用环境变量提供助记词):

export KEYSARK_MNEMONIC="word1 word2 … word12"
ark get secure/api-key > key.txt

环境变量

  • KEYSARK_SERVER服务端地址(等同 --server)。
  • KEYSARK_MNEMONIC直接提供助记词,跳过本机凭据——适合 CI / 脚本。
  • KEYSARK_HOME配置目录,默认 ~/.keysark。
  • KEYSARK_NO_BROWSER设置后登录时不自动打开浏览器。

安全说明

助记词、派生主密钥与明文永远不离开你的设备:ark 在本地加解密,只把密文发往服务端与网盘。设备授权态只能搬运密文;即便被泄露,也读不到你保险库里的任何内容。