gitlab-api-request

Gitlab api request (script)

Script for make request to the gitlab API

Installing

npm install -g gitlab-api-request

Getting Started

After install the library just type gr -h in a terminal and see the documentation.

Options

option -v / --version

Output the version number

option -t <token> / --token <token>

Gitlab personal token

option -l <level> / --logs <level>

Logs level error (only show errors), info (show errors and info logs), log (show any log) (default: "error")

option -a <version> / --api <version>

Api version (default: "v4")

option -u <url> / --url <utl>

Gitlab url (default: "https://gitlab.com")

option -h / --help

Output usage information

Commands

command config

Action over gr global configurations.

action set

Set a configuration parameter in global configurations

gr config set "token"="MY_TOKEN"

action get

Get a configuration parameter value from global configurations

gr config get token

action unset

Unset a configuration parameter from global configurations

gr config unset token

command issues

Allow actions over gitlab issues api

action: list

List of issues. In the example are filter by milestone:

gr --token <user-token> issues list "milestone"="2019-02"

action: my-estimations

Estimation and spend time of the filter issues. In the example the issues are filter by milestone:

gr --token <user-token> issues my-estimations "milestone"="2019-02"

result:

Estimate 48.5
Spent 0
Issues 17

Testing code

npm test

For generate the coverage you can use the next script:

npm run test:cov

Linting code

npm run lint

Built With

• npm - Dependency Management
• mocha - The test frameword used
• chai - BDD / TDD assertion library

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Guillermo González - Initial work - wil92