Redmine Issues Rest API

Redmine Issues Rest API Client for node.js

Getting Started

Install globally:

npm install -g redmine-issues

Options

• -h, --help Get usage information.
• -V, --version Get the version number.
• -c, --config Set main configuration.
• -q, --query Get issues for your user.
• -l, --limit Limit issues query.
• -i, --issue Set and Get issue information.
• -p, --percent Set issue percent.
• -m, --message Set issue message/note.
• -e, --estimated Set issue estimated hours.

-c, --config

Type: String Syntax: key:value

Set main configuration, can only be used with sudo, for security reasons.

domain

Required: true

sudo redmine -c domain:yourdomain.com

apikey

Required: true

sudo redmine -c apikey:here_your_api_key

port

Default: 80

sudo redmine -c port:80

contenttype

Default: application/json

sudo redmine -c contenttype:application/json

head

Default: green

sudo redmine -c head:blue

border

Default: cyan

sudo redmine -c border:grey

-q, --query

Type: Boolean

Return a redmine issues list of the current user.

redmine -q

-l, --limit

Optional: true Default: 5

redmine -q -l 20

-i, --issue

Type: Number

Set and Get issue information.

Get

-i, Get information of issue #45678.

redmine -i 45678

Set

-p, --percent

Set progress to 15%.

redmine -i 45678 -p 15

-m, --message

Set note.

redmine -i 45678 -m "my note"

-e, --estimated

Set estimated hours to 9.

redmine -i 45678 -e 9

Combining options

Set percent to 25% and Set note.

redmine -i 45678 -p 25 -m "my note"

Set percent to 30%, Set note and Set estimated hours to 5.

redmine -i 45678 -p 30 -m "my note" -e 5

Additional features

If you are using git and your branch is called issues#45678 then redmine-issues automatically recognize the issue id is 45678 and then not necessary that you indicate the issue id.

So to update this issue only write:

redmine -p 35

No need to specify the id of the issue.