Skip to content

Command Structure

Almost every command has the same shape:

redi <resource> <action> [<resource_id>] [options]
  • <resource> — a Redmine resource: issue, project, wiki, time_entry, news, …
  • <action>list, view, create, update, delete, comment
  • <resource_id> — the issue number or similar ID, for actions that target one item
Terminal window
redi issue list # list issues
redi issue view 160 # one issue
redi issue update 160 --status_id 3

<resource_id> is required for the actions that target one item: view, update, delete and comment.

redi <resource> on its own means redi <resource> list.

Terminal window
redi issue # same as: redi issue list

Both halves have short forms, so the commands stay short in daily use.

Resources i = issue, p = project, te = time_entry, w = wiki, ij = issue_journal, …
Actions l = list, v = view, c = create, u = update, d = delete, co = comment
Terminal window
redi i l # redi issue list

init, me and relation have no alias.

Option
--profile <name> Use another Redmine for this one command. Works at every level
--format <plain|json> Output format. plain (default) is the human-readable output, json is the raw JSON
--full Alias of --format json

list actions also take --limit / --offset for paging, plus filters that vary per resource.