From 8da5d6ed87b44acedc11f82e942c8591fb1d00c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Tue, 9 Jan 2024 09:50:10 +0100 Subject: [PATCH] more usage --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4dd3d63..6003ae8 100644 --- a/README.md +++ b/README.md @@ -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). \ No newline at end of file +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))) +