Version de développement

Cette documentation décrit la version « next » (develop), non encore publiée. Pour la version stable, basculez sur « v5 » dans l'en-tête.

Dokos CLI

Installation

Installer Dokos CLI avec uv, pipx ou pip, vérifier l'installation, activer la complétion et tenir l'outil à jour avec dokos self-update.

dokos est un paquet Python standard. Il installe une seule commande : dokos.

Prérequis

Python ≥ 3.11
uv ou pipx, ou pip

Installation

Avec uv

uv tool install git+https://gitlab.com/dokos/dokos-cli.git@v5

Avec pipx

pipx installe également l'outil dans un environnement isolé et le rend disponible globalement :

pipx install "git+https://gitlab.com/dokos/dokos-cli.git@v5"

Pour le développement (éditable)

Depuis une copie locale du dépôt :

pip install -e .

Cette méthode installe la commande dokos en mode éditable : les modifications du code source sont prises en compte immédiatement.

Vérifier l'installation

dokos --version
dokos guide
dokos get-list "User" --limit 5

dokos --version affiche la version installée.
dokos guide affiche une présentation de l'outil. Cette commande ne demande ni site ni identifiants.
dokos get-list demande une configuration valide vers un site.

Shell	Commande
bash	`echo 'eval "$(dokos completion bash)"' >> ~/.bashrc`
zsh	`echo 'eval "$(dokos completion zsh)"' >> ~/.zshrc`
fish	`dokos completion fish > ~/.config/fish/completions/dokos.fish`

Mises à jour

dokos vérifie au plus une fois par jour si une nouvelle version publiée existe sur GitLab. Si c'est le cas, il affiche un message d'une ligne.

dokos self-update          # met à jour selon la méthode d'installation détectée
dokos self-update --check  # signale seulement si une mise à jour est disponible (n'installe rien)
dokos self-update -y       # met à jour sans demander de confirmation

La mise à jour s'adapte à la méthode d'installation :

Installation	Comportement de `dokos self-update`
uv	pas encore prise en charge sur la branche `v5` : relancez `uv tool install --force "git+https://gitlab.com/dokos/dokos-cli.git@v5"`
pipx	`pipx install --force`
pip	`pip install -U`
éditable (développement)	jamais modifiée : affiche seulement les étapes `git pull`

Le dépôt gitlab.com/dokos/dokos-cli est public, sous licence MIT. Vous pouvez l'installer et l'utiliser librement. La recherche de version et la mise à jour fonctionnent sans jeton GitLab. Si GitLab ne répond pas, la vérification quotidienne ne signale rien et la commande continue.