laborious
v0.6.5
Published
⚗️ CLI tools for the lazy Gitlab user
Downloads
59
Readme
laborious
CLI tools for the lazy Gitlab developer.
laborious
is a CLI app to execute common tasks (create Merge Request, checkout Merge Request for review, ...) without the need to access Gitlab's web view.
Install
Requires git 2.7+ and node 8+ to be installed.
$ yarn add -D laborious
or
$ npm install -D laborious
Usage
It is recommended to add laborious
to your package.json
's scripts. This way you have easy access to all commands via yarn
/npm
.
For example, if you add the following to your scripts, you can do yarn lab <command>
or npm run lab <command>
to run laborious
.
{
"scripts": {
"lab": "laborious"
}
}
Available Commands
Note, you can run laborious
without any commands to view the help and get an overview of all available commands.
init
Alias: i
Create a laborious.json
configuration file. You'll get ask some questions and the file will be created for you afterwards.
open
Alias: o
Uses your default browser to open the homepage of your project in Gitlab.
merge-request
Alias: mr
Create a merge request for the current branch. The target branch is specified in your laborious
config.
checkout
Alias: co
List available Merge Requests and branches. Select one of them to switch to the corresponding branch. This will also try to update the branch to the latest commit.
ping
Ping Gitlab API.
Configuration
In order to get information about your project from Gitlab, laborious
uses the configured git origin to infer the location of the Gitlab API. Make sure your project is hosted on (self-hosted) Gitlab! If you want to test, if laborious
can reach your Gitlab, use the ping
command.
Authentication
Some commands, like creating a Merge Request, require authentication. laborious
will ask you for a personal access token if this is the case.
You can also add the token manually, by creating a .laborious
in your home directy.
Integration with yargs
Since laborious
is using yargs
as CLI framework, you can require commands directly if you're already have your own CLI build with yargs
.
To integrate laborious
' commands in your CLI you can do the following:
import { getCommandsDir } from 'laborious';
import yargs from 'yargs';
const argv = yargs
.commandDir('./my-commands')
.commandDir(getCommandsDir())
.alias('help', 'h').argv;