# @gjermundgaraba/clankerauth 中文文档

规范地址：https://npmcn.com/package/%40gjermundgaraba/clankerauth/

版本：0\.35\.1
npm 元数据更新时间：2026-11-11T02:09:09.679Z
中文译文更新时间：2026-11-16T15:28:00.258Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gjermundgaraba/clankerauth
原文对照：https://npmcn.com/package/%40gjermundgaraba/clankerauth/?lang=original
源码仓库：https://github.com/gjermundgaraba/clankerauth

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：28.6 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=26\.13\.0
- 运行依赖：4 个
- 首次发布：2026-10-09T12:17:58.558Z
- 最新版本发布：2026-11-11T02:09:09.301Z
- 近 30 天下载量：3531（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 29 个）

## 中文简介

Crankerauth 命令行:向作为它的主人的发行商签名,并管理HTTP.

## 安装

```sh
npm install @gjermundgaraba/clankerauth
```

也可以使用：`pnpm add @gjermundgaraba/clankerauth`、`yarn add @gjermundgaraba/clankerauth`、`bun add @gjermundgaraba/clankerauth`

## README

# @gjermundgaraba/clankerauth (英语)

这个 `clankerauth` 命令: 签名到 a [科克劳斯](https://github.com/gjermundgaraba/clankerauth) 发行人作为它的拥有者,在HTTP上运行每一个管理动作,并且为发行人的资源交出其他指令访问符. 它需要节点26或更新和0.24.0或以后的发行人,或0.28.0,用于管理键 `CLANKERAUTH_TOKEN`。 。 。 .

```sh
npm install --global @gjermundgaraba/clankerauth

clankerauth login https://clankerauth.home.example
clankerauth list-clients
clankerauth create-api-key --name "notes sync" \
  --permissions '{"https://notes.home.example/":["notes:read"]}' --expires-at null
clankerauth logout
```

`login <url>` 输入资源 `url` 识别,从它的 `/.well-known/oauth-protected-resource`: 发行者自己的出身, `CLANKERAUTH_BASE_URL`,发布管理,一个应用程序的URL发布其资源. 然后它发现了资源名称的发行者; 将那里的命令注册为本地的 OAuth 客户端, 每个登录符都有一个新的客户端; 在浏览器中打开批准页面, 在 Stderr 上打印它的 URL, 用于一个没有浏览器可打开的终端, 或者单独打开 `--no-browser`;并听取回回路端口上的定向. 它要求资源的所有范围, `clankerauth:read clankerauth:write` 用于行政管理,除非 `--scope` 名称减少: `--scope clankerauth:read` 列表,永不更改。 除了他们,它要求 `offline_access`,仅用于发布无范围的资源。 资源必须公布该文件,因此由 `http:` 或者说 `https:` URL,待签入.

门牌都放在里面 `$XDG_CONFIG_HOME/clankerauth/sign-ins.json`, (中文(简体) ), `~/.config/clankerauth/sign-ins.json` 默认情况下,由所有者单独读取:每个资源一个,每个资源都有自己的发行人,所以在第二个发行人签名后,第一个资源就留给自己了. 命令无法读取的文件, 如所写的版本、 已签名的文件和下一个文件 `login` 替换它。 A 类 `login` 到一个已签名的资源来替换该登录并撤销它。 命令会刷新即将到期的访问令牌,并保存所旋转的刷新令牌,所以在至少每30天使用一次时,登录会持续;当签发者拒绝刷新时,错误名称为: `login` 那又需要同样的瞄准镜 对文件的每次更改都会锁住锁,所以命令和程序会同时运行,刷新一次过期的登录,以及 `logout` 撤销当前刷新符号. `logout` 撤销所有登录并删除文件,以及 `logout <url>` 该 URL 的资源是单独存在的.

行政命令在所保存的一个行政当局的签发人处行事。 几个发行商向行政部门登记,名称为 `CLANKERAUTH_URL`,其来源;没有名称的值,例如 `mailto:` URL 被拒绝 .

未受关注, 例如在一个没有浏览器或磁盘来保持登录的容器中, 命令会占用管理密钥, 在发行者的发端根上授予的 API 密钥, 来源于 `CLANKERAUTH_TOKEN` 然后在发行人那里行动 `CLANKERAUTH_URL` 姓名,他们需要。 不读不写签入. 拥有者一次创建密钥, 签名于 :

```sh
clankerauth create-api-key --name deployer --expires-at null \
  --permissions '{"https://clankerauth.home.example/":["clankerauth:read","clankerauth:write"]}'

CLANKERAUTH_URL=https://clankerauth.home.example CLANKERAUTH_TOKEN=clankerauth_… \
  clankerauth list-api-keys
```

钥匙可以做什么,如果对钥匙作了修改,则在 [发行人的读取器](https://npmcn.com/package/README.md#administer-unattended-with-an-api-key)。 。 。 .

## 其他命令的键

`token <url>` 打印已签名的资源的当前访问令牌,以表示URL的下限,数个时最具体,没有其他的,当它即将到期时首先刷新它;没有URL,它就打印行政部门的。 另一个命令,或者一个脚本,从那里获得它的无记名符号,而不是保存一个密钥;一个使用效果的程序 `token` 联 合 国 [`@gjermundgaraba/clankerauth-sdk/credentials`](https://npmcn.com/package/packages/sdk/README.md) 相反,它读取并刷新同样的登录:

```sh
clankerauth login https://notes.home.example
curl -H "authorization: Bearer $(clankerauth token https://notes.home.example/api/list-notes)" \
  https://notes.home.example/api/list-notes
clankerauth logout https://notes.home.example
```

所有其他命令都是行政行动,在kebab案件中以它命名,每个输入字段都有一面旗帜: `clankerauth <command> --help` 列出他们。 一个非文本字段需要 JSON, 例如 `--permissions` 上层或 `--expires-at null`。一个命令在 stdout 上打印动作结果为 JSON,在 stderr 上打印拒绝,退出 1 。 一个创建的 API 密钥或客户端密钥在 JSON 一次, 所以发送到它所属的地方:

```sh
clankerauth create-api-key --name "machine" \
  --permissions '{"https://creds.home.example/":["creds:machine"]}' --expires-at null \
  | jq -r .key > key
```

麻省理工学院有执照.

## 常见问题

### @gjermundgaraba/clankerauth 是什么？

Crankerauth 命令行:向作为它的主人的发行商签名,并管理HTTP\.

### 如何安装 @gjermundgaraba/clankerauth？

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

### @gjermundgaraba/clankerauth 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gjermundgaraba\_\_clankerauth 是否存在。

### @gjermundgaraba/clankerauth 支持 ESM 还是 CommonJS？

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

### @gjermundgaraba/clankerauth 需要什么版本的 Node\.js？

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

### @gjermundgaraba/clankerauth 可以商用吗？

@gjermundgaraba/clankerauth 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gjermundgaraba/clankerauth 的下载量有多少？

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

### @gjermundgaraba/clankerauth 还在维护吗？

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

