Skip to content

Other Commands

Make authenticated requests to any Redmine REST API endpoint:

Terminal window
# GET the current user
redmine api /users/current.json
# GET with query parameters
redmine api /issues.json -f project_id=myproject -f limit=5
# POST with JSON fields (method auto-detected)
redmine api /issues.json -F 'issue[subject]=Bug report' -F 'issue[project_id]=1'
# POST from a file (use - for stdin)
redmine api /issues.json --input body.json
# Explicit HTTP method
redmine api -X DELETE /issues/123.json
# Show response headers
redmine api /issues.json -i
# Suppress output
redmine api -X PUT /issues/123.json -F 'issue[status_id]=5' --silent
FlagShortDescription
--method-XHTTP method (default: GET, or POST when body provided)
--field-fQuery parameter as key=value (repeatable)
--raw-field-FJSON body field as key=value (repeatable)
--inputRead request body from file (- for stdin)
--include-iShow response status line and headers
--silentSuppress response output

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

List issue categories for a project:

Terminal window
redmine categories list --project <identifier>

List all available trackers:

Terminal window
redmine trackers list

List all issue statuses:

Terminal window
redmine statuses list

Generate completion scripts for your shell:

Terminal window
# 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
Terminal window
redmine update

Checks GitHub for the latest release, downloads it with SHA256 checksum verification, and replaces the current binary. If installed via Homebrew, delegates to brew upgrade.