more usage

This commit is contained in:
Julien Fastré 2024-01-09 09:50:10 +01:00
parent b4ffee2dd3
commit 8da5d6ed87
Signed by: julienfastre
GPG Key ID: BDE2190974723FCB
1 changed files with 23 additions and 2 deletions

View File

@ -8,6 +8,8 @@ Currently:
## Install & configure
### Install
Download the most recent binaries at https://gitea.champs-libres.be/julienfastre/cl-cli/releases
Once downloaded, install it:
@ -20,7 +22,7 @@ sudo install cl-cli /usr/local/bin/cl-cli
sudo install cl-cli /usr/local/bin/cl
```
## Configure
### Configure
Copy the file [config.toml.dist](./config.toml.dist) as a template, and
save it at the path `$HOME/.config/cl-cli/config.toml`:
@ -31,4 +33,23 @@ cp config.toml $HOME/.config/cl-cli/config.toml
editor $HOME/.config/cl-cli/config.toml
```
Then, fill it with the required configuration options (gitlab and openproject token).
Then, fill it with the required configuration options (gitlab and openproject token).
## Usage
### Convert a gitlab issue into a work package
```bash
cl-cli planning i2work https://gitlab.com/Chill-Projet/chill-bundles/-/issues/240 chill
```
Where:
- `https://gitlab.com/Chill-Projet/chill-bundles/-/issues/240` is the URL of the issue
- `chill` is the identifier of the project in openproject (see the identifier
in the URL like the page "Vue globale": https://champs-libres.openproject.com/projects/chill/, or
see it there: https://champs-libres.openproject.com/projects/chill/identifier (Paramètres du projet / changer
l'identifiant (bouton en haut)))