Set up native messaging with debian packages (#6)
All checks were successful
Check go code / build-and-release (push) Successful in 1m2s

Reviewed-on: #6
Co-authored-by: Julien Fastré <julien.fastre@champs-libres.coop>
Co-committed-by: Julien Fastré <julien.fastre@champs-libres.coop>
This commit is contained in:
2025-11-13 11:39:38 +00:00
committed by Julien Fastré
parent 9439f6afe1
commit af1b805616
7 changed files with 60 additions and 19 deletions

View File

@@ -6,23 +6,49 @@ Currently:
- convert a gitlab issue to a work package
## Install & configure
## Install
### Install
There are two components to install:
Download the most recent binaries at https://gitea.champs-libres.be/julienfastre/cl-cli/releases
- a firefox add-ons;
- some binaries on the host machine
Once downloaded, install it:
### Install firefox add-on
```
# this will install the command globally with the name "cl-cli"
sudo install cl-cli /usr/local/bin/cl-cli
Using firefox, download the `.xpi` file from the [release page](https://gitea.champs-libres.be/julienfastre/cl-cli/releases) of the `julienfastre/cl-cli` repository.
# this will install the command globally with the name "cl"
sudo install cl-cli /usr/local/bin/cl
### Install cl-cli binaries
#### Using package manager
A debian package is published and stored on gitea.
```bash
# download the gpg key
sudo curl https://gitea.champs-libres.be/api/packages/julienfastre/debian/repository.key -o /etc/apt/keyrings/gitea-julienfastre.asc
# add the package repository. You must adapt the $distribution (see below)
echo "deb [signed-by=/etc/apt/keyrings/gitea-julienfastre.asc] https://gitea.champs-libres.be/api/packages/julienfastre/debian $distribution main" | sudo tee -a /etc/apt/sources.list.d/gitea.list
# update
sudo apt update
# install
sudo apt install cl-cli
```
### Configure
Available distributions:
- Ubuntu 24..04: noble
- Ubuntu 25.04: plucky
- Ubuntu: 25.10: questing
**Note:** The package is very simple, there are very few dependencies, and there isn't any difference between them for now.
## 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`:
@@ -33,14 +59,19 @@ 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:
- gitea personal access token:
![configuration screenshort](./docs/configuration/gitea_screenshot_configure_pat.png)
- Gitlab: [Create an access token](https://gitlab.com/-/user_settings/personal_access_tokens?name=cl-cli&scopes=api,read_user) With the "api" and "read_user" scopes
- [Openproject](https://champs-libres.openproject.com/my/access_tokens)
## Usage
## Usage as CLI
### Convert a gitlab issue into a work package
```bash
cl-cli planning i2work https://gitlab.com/Chill-Projet/chill-bundles/-/issues/240 chill
```