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.

custom-fields Discover admin custom field definitions.

completion Generate shell completion scripts.

update Self-update the binary.

api

Make authenticated requests to any Redmine REST API endpoint.

GET

redmine api /users/current.json

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

POST

# Method auto-detected when body fields are supplied
redmine api /issues.json \
  -F 'issue[subject]=Bug report' \
  -F 'issue[project_id]=1'

From file

# - reads from stdin
redmine api /issues.json --input body.json

Explicit method

redmine api -X DELETE /issues/123.json
redmine 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

Tip

JSON responses are pretty-printed when stdout is a terminal. Non-2xx responses still print the body but exit with code 1.

categories

redmine categories list --project <identifier>

Lists issue categories for a project.

trackers

redmine trackers list
redmine trackers get Bug

Lists all available trackers. The list view includes the default status for each tracker, and trackers get shows richer metadata such as enabled standard fields when the Redmine server exposes them.

statuses

redmine statuses list

Lists all issue statuses.

custom-fields

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

Lists or inspects custom field definitions. The list view surfaces target resource type, field format, and the required/filter/searchable/multiple flags. custom-fields get adds the default value, length and regexp constraints, possible values for list fields, plus the trackers and roles a field is restricted to.

Caution

The underlying GET /custom_fields.json endpoint is admin-only - the command returns 403 Forbidden for non-admin API keys.

Shell completion

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

Note

Homebrew installs ship completions automatically — run the command above only if you installed via the script, go install, or manual download.

self-update

checksum verified

redmine update

Checks 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

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.0
https://github.com/aarondpn/redmine-cli/releases/tag/v1.3.0
Run "redmine update" to upgrade

The 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 update itself;
• stderr is not a TTY (piped output, CI);
• REDMINE_NO_UPDATE_CHECK is 1 or true.

To disable permanently:

export REDMINE_NO_UPDATE_CHECK=1