Files
cl-cli/README.md
Julien Fastré af1b805616
All checks were successful
Check go code / build-and-release (push) Successful in 1m2s
Set up native messaging with debian packages (#6)
Reviewed-on: #6
Co-authored-by: Julien Fastré <julien.fastre@champs-libres.coop>
Co-committed-by: Julien Fastré <julien.fastre@champs-libres.coop>
2025-11-13 11:39:38 +00:00

2.5 KiB

CL-cli utility

Provide a CLI interface for several recurring tasks for Champs-Libres

Currently:

  • convert a gitlab issue to a work package

Install

There are two components to install:

  • a firefox add-ons;
  • some binaries on the host machine

Install firefox add-on

Using firefox, download the .xpi file from the release page of the julienfastre/cl-cli repository.

Install cl-cli binaries

Using package manager

A debian package is published and stored on gitea.

# 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

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 as a template, and save it at the path $HOME/.config/cl-cli/config.toml:

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:

Usage as CLI

Convert a gitlab issue into a work package

cl-cli planning i2work https://gitlab.com/Chill-Projet/chill-bundles/-/issues/240 chill

Where: