其他命令

一组不归属于主要资源类别的实用命令。

api向任意 Redmine 端点发送已认证的请求。

categories列出项目的工单类别。

trackers列出所有可用的跟踪类型。

statuses列出所有工单状态。

custom-fields查询管理员自定义字段定义。

completion生成 shell 补全脚本。

update自动更新二进制文件。

api

向任意 Redmine REST API 端点发送已认证的请求。

GET

redmine api /users/current.json

redmine api /issues.json -f project_id=myproject -f limit=5

POST

# 提供请求体字段时会自动检测请求方法
redmine api /issues.json \
  -F 'issue={"subject":"Bug report","project_id":1}'

从文件读取

# - 表示从标准输入读取
redmine api /issues.json --input body.json

指定请求方法

redmine api -X DELETE /issues/123.json
redmine api -X PUT /issues/123.json -F 'issue={"status_id":5}' --silent

标志	描述
-X, --method	HTTP 方法（默认：GET，提供请求体时为 POST）
-f, --field	查询参数，格式为 key=value（可重复使用）
-F, --raw-field	JSON 请求体字段，格式为 key=value（可重复使用）
--input	从文件读取请求体（- 表示从标准输入读取）
-i, --include	显示响应状态行和标头
--silent	抑制响应输出

-F 设置的是顶层键

每个 -F key=value 都会成为 JSON 请求体的顶层键。数字、布尔值、数组和对象按 JSON 发送，其他值（包括无效的 JSON）按字符串发送。看起来像数字的值会按数字发送，因此 -F 'name=1.10' 发送的是 1.1。此类字符串请放在 JSON 对象中：-F 'version={"name":"1.10"}'。方括号写法不会被展开：-F 'issue[subject]=Bug' 发送的是一个字面名为 issue[subject] 的键，Redmine 会忽略它。这样的 PUT 请求仍会成功，但不会修改任何内容。请将嵌套对象作为 JSON 值传入（-F 'issue={"subject":"Bug"}'），或使用 --input 发送完整的请求体。

提示

当输出目标为终端时，JSON 响应将以格式化方式输出。4xx 和 5xx 响应仍会打印响应体，但以退出码 1 退出。在 JSON 模式（-o json 或 --jq）下且未使用 -i 时，此类响应会改为以 JSON 错误信封的形式写入 stderr，stdout 保持为空。

categories

redmine categories list --project <identifier>

列出项目的工单类别。

trackers

redmine trackers list
redmine trackers get Bug

列出所有可用的跟踪类型。列表视图会显示每个跟踪类型的默认状态，而 trackers get 会在 Redmine 服务器提供这些数据时展示更完整的元数据，例如启用的标准字段。

statuses

redmine statuses list

列出所有工单状态。

custom-fields

redmine custom-fields list
redmine custom-fields get "Severity"
redmine custom-fields get 7 --output json

列出或查看自定义字段定义。列表视图会展示目标资源类型、字段格式以及是否必填、可筛选、可搜索、可多选等标志。custom-fields get 还会显示默认值、长度与正则约束、列表字段的可选值，以及该字段限定的跟踪类型与角色。

警告

底层的 GET /custom_fields.json 端点仅限管理员访问，使用非管理员 API key 时命令会返回 403 Forbidden。

注意

Redmine 7.0 扩展了该端点，custom-fields get 会在表格输出中展示这些新增信息：

• For All Projects 与 Projects 描述字段的项目适用范围。Redmine 仅针对工单自定义字段返回项目范围，因此工时、项目和版本字段永远不会出现这两行。
• Roles 现在也会针对工时、项目和版本字段返回，而较旧的服务器仅针对工单字段返回。
• Default Mode 出现在使用相对默认值的日期格式字段上（例如 days_after_today）。

当服务器不返回该标志时，For All Projects 行会被整行省略，而不是显示为 no，因此该行缺失表示「服务器未提供该信息」，绝不表示「受到限制」。Projects 行缺失的含义则不同：它表示该字段未限定到特定项目，对工单字段而言通常意味着适用于所有项目。

Shell 补全

bash

redmine completion bash > /etc/bash_completion.d/redmine

zsh

redmine completion zsh > "${fpath[1]}/_redmine"

fish

redmine completion fish > ~/.config/fish/completions/redmine.fish

注意

通过 Homebrew 安装时会自动附带补全脚本——仅当通过安装脚本、go install 或手动下载安装时才需运行上述命令。

跟踪器、版本、类别和成员名称等补全候选项来自服务器。bash 脚本会在 bash 看到它们之前先加引号，因此像 $(cmd) 这样的名称只会作为文本给出，绝不会被执行；包含换行的候选项会被丢弃，控制字符会被中和。旧版本生成的 bash 脚本会把候选项不加引号地交给 bash：如果你把 redmine completion bash 的输出保存到了文件中，升级后请重新生成该文件。

自动更新

已验证校验和 已验证证明

redmine update

检查 GitHub 是否有最新版本并下载，只有通过以下两项检查后才会替换当前二进制文件：

1. 校验和：归档文件的 SHA256 必须与该版本的校验和文件一致。
2. 证明（attestation）：归档文件的 SHA256 必须具有 GitHub artifact attestation（SLSA 构建来源证明，经 Sigstore 签名并记录在其透明日志中），且由本仓库的 release.yml 工作流针对正在安装的这个版本标签签发。

除仓库外，内置检查还会固定签名工作流和源引用，因此比单独运行 gh attestation verify --repo aarondpn/redmine-cli 更严格。等效的 gh 命令如下（Windows 归档文件以 .zip 结尾）。安装了较新且已登录的 gh 时，install.sh 会运行该命令；否则脚本只校验校验和后即安装，并打印该命令供你自行验证（参见安装）：

gh attestation verify redmine-cli-<os>-<arch>.tar.gz --repo aarondpn/redmine-cli \
  --signer-workflow aarondpn/redmine-cli/.github/workflows/release.yml \
  --source-ref refs/tags/<tag>

校验和与归档文件来自同一位置，因此只有证明才能证实二进制文件确实由本项目的发布流水线构建。如果证明缺失、无效或由其他身份签名，更新会被拒绝。版本发布后几分钟才会生成证明；如果在发布后 30 分钟内更新而证明尚未生成，redmine update 会说明这一点并提示稍后重试，而不会报告验证失败。

通过 Homebrew 安装时，将委托给 brew upgrade 执行。

标志	描述
--skip-attestation	仅校验校验和后安装，并打印警告。

验证需要访问 api.github.com（attestations API）和 tuf-repo-cdn.sigstore.dev（Sigstore 信任根，在用户缓存目录中缓存一天）。任一地址无法访问时，redmine update 会拒绝安装并建议使用 --skip-attestation。设置 GITHUB_TOKEN 或 GH_TOKEN 可避免 GitHub API 速率限制；该令牌只会发送给 api.github.com。

验证失败时不要跳过

--skip-attestation 仅适用于屏蔽了验证端点的网络环境。如果验证失败（而不是无法访问），请不要绕过，而应将其作为安全问题报告。安装脚本中的等效开关 REDMINE_CLI_SKIP_ATTESTATION=1 同样如此。

如果二进制文件所在目录不可写，错误信息会建议使用同一版本标签下的 install.sh 重新安装，而不是使用 main 分支上的脚本。

启动时更新检查

每次执行命令时，redmine 会在后台检查 GitHub 是否有新版本。如有新版本，会在命令输出后将提示信息打印至 stderr：

A new version of redmine is available: v1.2.0 → v1.3.0
https://github.com/aarondpn/redmine-cli/releases/tag/v1.3.0
Run "redmine update" to upgrade

检查与命令同时在后台启动，并在启动 2 秒后放弃。只有命令成功时才会打印结果；命令失败时会立即退出。如果命令结束时检查仍在进行，CLI 会等待它，最多等到这个 2 秒的截止时间；等待超过 200 毫秒时会向 stderr 打印 Checking for updates...。有效的缓存结果（见下文）会立即返回，因此只有需要询问 GitHub 时才会出现这种延迟：成功检查后每天一次，但在检查失败或超时期间则每次运行都会发生（失败结果不会被缓存）。以下情况下会自动跳过检查：

• 当前命令本身是 redmine update；
• stderr 不是 TTY（管道输出或 CI 环境）；
• REDMINE_NO_UPDATE_CHECK 的值为 1 或 true。

检查结果会在 ~/.redmine-cli-update-check.json 中缓存 24 小时（仅你本人可读）。如果缓存条目中的版本 URL 不是 https://github.com/aarondpn/redmine-cli/releases/tag/ 下的版本页面，该条目会被忽略，因此被篡改的缓存无法向提示信息中注入链接。

如需永久禁用：

export REDMINE_NO_UPDATE_CHECK=1