add some docs

This commit is contained in:
Julien Fastré 2024-01-09 09:41:46 +01:00
parent 708be9bdc4
commit b4ffee2dd3
Signed by: julienfastre
GPG Key ID: BDE2190974723FCB
2 changed files with 35 additions and 0 deletions

View File

@ -30,6 +30,7 @@ jobs:
with: with:
files: |- files: |-
target/release/cl-cli target/release/cl-cli
config.toml.dist
api_key: '${{secrets.RELEASE_TOKEN}}' api_key: '${{secrets.RELEASE_TOKEN}}'
body: | body: |
${{ steps.read_release.outputs.content }} ${{ steps.read_release.outputs.content }}

34
README.md Normal file
View File

@ -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).