Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jansanchez/redmine-issues
Redmine Issues Rest API Client for node.js
https://github.com/jansanchez/redmine-issues
Last synced: 27 days ago
JSON representation
Redmine Issues Rest API Client for node.js
- Host: GitHub
- URL: https://github.com/jansanchez/redmine-issues
- Owner: jansanchez
- License: mit
- Created: 2014-07-08T19:11:41.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-03T23:27:15.000Z (about 10 years ago)
- Last Synced: 2024-09-17T01:41:23.897Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 344 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redmine Issues Rest API [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
> 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 version number.
- `-c, --config` Set main configuration.
- `-q, --query` Get user issues.
- `-l, --limit` Limit the number of query issues.
- `-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`
For security reasons, setting the main configuration can only be used with `sudo`.
#### 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're using git and the name of your branch is issues#45678 then redmine-issues automatically recognizes the issue id (45678) so that you don't have to indicate it.
so that you don't have to type it.
```
redmine -p 35
```
No need to specify the id of the issue.
[downloads-image]: http://img.shields.io/npm/dm/redmine-issues.svg
[npm-url]: https://www.npmjs.org/package/redmine-issues
[npm-image]: http://img.shields.io/npm/v/redmine-issues.svg
[travis-url]: https://travis-ci.org/jansanchez/redmine-issues
[travis-image]: http://img.shields.io/travis/jansanchez/redmine-issues.svg