Tutorials
Tip
Always remember, when in doubt use --help.
Getting help
To see the options use --help flag after the command.
labelx --help
This should output the help information on screen and it looks something similar as below -
Usage: labelx [OPTIONS] COMMAND [ARGS]...
GitLab label creator control panel
Options:
--debug Turns on DEBUG mode. [default: False]
--version Show the version and exit.
--help Show this message and exit.
Commands:
create-badges Create badges for project.
create-labels Create labels for issues and merge requests.
pkg-info Shows package information.
To checkout individual options for any command use --help flag.
labelx pkg-info --help
This command should show all the available arguments for info sub-command.
Usage: labelx pkg-info [OPTIONS]
Prints information about the package
Options:
--help Show this message and exit.
Turning on debug
Sometimes program runs into ERROR and there are not enough data shown on screen to
determine the cause of the ERROR. For getting verbose output of all the actions
done by the program simply turn on the debug mode with --debug flag.
By default it’s turned off.
To turn on debug mode -
labelx --debug create-labels [OPTIONS] [ARGS]
Also you can turn on the debug mode at sub-command level by using --debug
flag after the sub-command
labelx create-labels [OPTIONS] [ARGS] --debug
OR like this -
labelx create-labels --debug [OPTIONS] [ARGS]
Creating Labels
To create default labels, use the following command -
labelx create-labels -p [gitlab project id]
To create group labels use -g flag
labelx create-labels -g [gitlab group id]
Example
labelx create-labels -p 12345
This command should run the program with preset labels and create these labels
in the project mentioned. Output should be something similar -
(output is from version 2.1.1)
+--------------------------------------------------+
| labelx |
+--------------------------------------------------+
| about: GitLab label/badge creator |
| author: Dalwar Hossain (dalwar23@pm.me) |
| version: 2.1.1 |
| license: GNU General Public License v3 |
| documentation: https://labelx.readthedocs.io/ |
+--------------------------------------------------+
[*] Initializing.....
[*] Please use 'labelx --help' to see all available options
-------------------------------------- [labelx] ----------------------------------------
[$] Creating label - [Bug] ..... DONE
[$] Creating label - [Done] ..... DONE
[$] Creating label - [Feature Upgrade] ..... DONE
[$] Creating label - [Fixed] ..... DONE
[$] Creating label - [New Feature Request] ..... DONE
[$] Creating label - [On Hold] ..... DONE
[$] Creating label - [P1] ..... DONE
[$] Creating label - [P2] ..... DONE
[$] Creating label - [P3] ..... DONE
[$] Creating label - [Planned] ..... DONE
[$] Creating label - [Source Code Refactoring] ..... DONE
[$] Creating label - [Testing] ..... DONE
[$] Creating label - [WIP] ..... DONE
[$] Creating label - [Won't Fix] ..... DONE
-------------------------------------- Goodbye! ----------------------------------------
Using user defined labels
Note
When using user defined labels, the builtin labels will be ignored.
To create user defined labels, use -f or --labels option with an argument of a
valid yaml file path that contains label information. E.g.
labelx create-labels -p 1234 -f ~/labels.yaml
OR
labelx create-labels -g 23 --labels ~/my/vey/nested/file/path/to/labels.yaml
Example labels.yaml file
Test1:
color: "#FF0000"
description: A test label
description_html: ''
text_color: "#FFFFFF"
subscribed: false
priority: 0
is_project_label: true
Test2:
color: "#0033CC"
description: Second test label
description_html: ''
text_color: "#FFFFFF"
subscribed: false
priority: 1
is_project_label: true
Test3:
color: "#AD4363"
description: Third test label
description_html: ''
text_color: "#FFFFFF"
subscribed: false
priority:
is_project_label: true
Creating Badges
To create default badges, use the following command -
labelx create-badges -p [gitlab project id]
To create group badges use -g flag with numeric group id.
labelx create-badges -g [gitlab group id]
Note
Group badges require owner permission for the group in context.
Example
labelx create-badges -p 1245
This command should run the program with preset badges and create these badges
in the project mentioned. Output should be something similar -
(output is from version 2.1.1)
+--------------------------------------------------+
| labelx |
+--------------------------------------------------+
| about: GitLab label/badge creator |
| author: Dalwar Hossain (dalwar23@pm.me) |
| version: 2.1.1 |
| license: GNU General Public License v3 |
| documentation: https://labelx.readthedocs.io/ |
+--------------------------------------------------+
[*] Initializing.....
[*] Please use 'labelx --help' to see all available options
-------------------------------------- [labelx] ----------------------------------------
[$] Creating badge - [license] ..... DONE
[$] Creating badge - [platform] ..... DONE
[$] Creating badge - [windows] ..... DONE
[$] Creating badge - [linux] ..... DONE
[$] Creating badge - [macos] ..... DONE
[$] Creating badge - [python] ..... DONE
[$] Creating badge - [style] ..... DONE
[$] Creating badge - [layout] ..... DONE
-------------------------------------- Goodbye! ----------------------------------------
Using user defined badges
Note
When using user defined badges, the builtin badges will be ignored.
To create user defined badges, use -f or --badges option with an argument of a
valid yaml file path that contains badge information. E.g.
labelx create-badges -p 143 -f ~/badges.yaml
OR
labelx create-badges -g 23 --badges ~/my/vey/nested/file/path/to/badges.yaml
Example badges.yaml file
---
license:
link_url: "%{project_path}/LICENSE"
image_url: "https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square"
position: 0
platform:
link_url: "%{project_path}"
image_url: "https://img.shields.io/badge/Platform-cc3300?style=flat-square"
position: 1
windows:
link_url: "%{project_path}"
image_url: "https://img.shields.io/badge/Windows-blue?style=flat-square&logo=windows"
position: 2
linux:
link_url: "%{project_path}"
image_url: "https://img.shields.io/badge/Linux-333?style=flat-square&logo=linux"
position: 3
Important
%{project_path} will translated into the project’s path by labelx for project specific
badges only. For groups, It is recommended not to use GITLABPLACEHOLDERTOKENS like
%{project_path} or %{project_id}.