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
Resource and action
Section titled “Resource and action”redi issue list # list issuesredi issue view 160 # one issueredi 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.
redi issue # same as: redi issue listAliases
Section titled “Aliases”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 |
redi i l # redi issue listinit, me and relation have no alias.
Global options
Section titled “Global options”| 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.