Other Commands
A grab-bag of utility commands that don’t fit the main resource families.
api Authenticated requests to any Redmine endpoint.
categories List issue categories for a project.
trackers List all available trackers.
statuses List all issue statuses.
completion Generate shell completion scripts.
update Self-update the binary.
Make authenticated requests to any Redmine REST API endpoint.
redmine api /users/current.json
redmine api /issues.json -f project_id=myproject -f limit=5# Method auto-detected when body fields are suppliedredmine api /issues.json \ -F 'issue[subject]=Bug report' \ -F 'issue[project_id]=1'# - reads from stdinredmine api /issues.json --input body.jsonredmine api -X DELETE /issues/123.jsonredmine api -X PUT /issues/123.json -F 'issue[status_id]=5' --silent| Flag | Description |
|---|---|
-X, --method | HTTP method (default: GET, or POST when a body is provided) |
-f, --field | Query parameter as key=value (repeatable) |
-F, --raw-field | JSON body field as key=value (repeatable) |
--input | Read request body from file (- for stdin) |
-i, --include | Show response status line and headers |
--silent | Suppress response output |
categories
Section titled “categories”redmine categories list --project <identifier>Lists issue categories for a project.
trackers
Section titled “trackers”redmine trackers listLists all available trackers.
statuses
Section titled “statuses”redmine statuses listLists all issue statuses.
Shell completion
Section titled “Shell completion”redmine completion bash > /etc/bash_completion.d/redmineredmine completion zsh > "${fpath[1]}/_redmine"redmine completion fish > ~/.config/fish/completions/redmine.fishself-update
Section titled “self-update”redmine updateChecks GitHub for the latest release, downloads it with SHA256 checksum verification, and replaces the current binary. When installed via Homebrew, delegates to brew upgrade.
Startup update check
Section titled “Startup update check”On every invocation, redmine checks GitHub for a newer release in the background. When one is available, a notice is printed to stderr after the command output:
A new version of redmine is available: v1.2.0 → v1.3.0https://github.com/aarondpn/redmine-cli/releases/tag/v1.3.0Run "redmine update" to upgradeThe check runs in a goroutine with a 3-second timeout, so it never delays the CLI. It is automatically skipped when:
- the command is
redmine updateitself; - stderr is not a TTY (piped output, CI);
REDMINE_NO_UPDATE_CHECKis1ortrue.
To disable permanently:
export REDMINE_NO_UPDATE_CHECK=1