From b4ffee2dd339e3687bfed2ba896dd233439fea2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Tue, 9 Jan 2024 09:41:46 +0100 Subject: [PATCH] add some docs --- .../workflows/release/build-and-release.yaml | 1 + README.md | 34 +++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 README.md diff --git a/.gitea/workflows/release/build-and-release.yaml b/.gitea/workflows/release/build-and-release.yaml index d6a12d4..af915bf 100644 --- a/.gitea/workflows/release/build-and-release.yaml +++ b/.gitea/workflows/release/build-and-release.yaml @@ -30,6 +30,7 @@ jobs: with: files: |- target/release/cl-cli + config.toml.dist api_key: '${{secrets.RELEASE_TOKEN}}' body: | ${{ steps.read_release.outputs.content }} diff --git a/README.md b/README.md new file mode 100644 index 0000000..4dd3d63 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# CL-cli utility + +Provide a CLI interface for several recurring tasks for Champs-Libres + +Currently: + +- convert a gitlab issue to a work package + +## Install & configure + +Download the most recent binaries at https://gitea.champs-libres.be/julienfastre/cl-cli/releases + +Once downloaded, install it: + +``` +# this will install the command globally with the name "cl-cli" +sudo install cl-cli /usr/local/bin/cl-cli + +# this will install the command globally with the name "cl" +sudo install cl-cli /usr/local/bin/cl +``` + +## 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`: + +```bash +mkdir -p $HOME/.config/cl-cli +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