@customd/labot
v1.5.1
Published
A simple CLI toolbox providing helpful GitLab commands
Downloads
10
Readme
(Git)LaBot - Custom D tools for GitLab
LaBot is a command-line toolset that assists with some of the grunt-work required for project setup.
Documentation
Documentation is still in development, but will be made available at https://custom-d.customd.io/npm/labot
Installation
To install LaBot CLI, run the following command:
npm install -g @customd/labot
Usage
Help
For command help output, run:
labot help <command>
E.g.,
labot help sync-labels
Configure GitLab access
To configure the CLI tool for GitLab access, run labot configure
. The command will prompt you for your GitLab instance URL, and Personal Access Token. This token requires at least (api) permission.
labot configure
This CLI tool shares configuration with other @customd/
CLI tools.
Environment variables
Alternatively, you can configure the tool using the following environment variables:
| Name | Description |
| ------------ | ------------------------------------------------------------------------------- |
| GITLAB_URL | The URL at which to connect to your GitLab instance. E.g., https://gitlab.com
|
| GITLAB_TOKEN | The access token to use when connecting to GitLab's API. |
Copy GitLab labels from one group to another
This command allows you to copy group level labels from one group, to another. This allows for consistent labelling across projects.
Example
Executing this command will sync the default labels to the target group.
labot sync-labels -t <target-group-id>
What exactly does it do?
- Add labels from the source group to the target group.
- Update existing labels in the target group to match the source group colours & description.
- List out any labels in the target group that don't exist in the source group, so you can manually review & delete as required.
Uninstallation
To uninstall (Git)LaBot CLI, run the following command:
npm uninstall -g @customd/labot
License
Licensed under the MIT license.