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 pipx ou pip, vérifier la connexion, et maintenir l'outil à jour avec dokos self-update.
dokos est un paquet Python standard. Il installe une seule commande : dokos.
Prérequis
- Python ≥ 3.11
- pipx (recommandé) ou pip
Le dépôt
dokos-cli est privé. Pour l'installer ou vérifier les mises à jour, un jeton GitLab (GITLAB_TOKEN) est nécessaire, ou une configuration via dokos configure.Installation recommandée (pipx)
pipx installe l'outil dans un environnement isolé et le rend disponible partout. Épinglez une version publiée (<tag>) :
pipx install "git+https://gitlab.com/dokos/dokos-cli.git@<tag>"
Installation 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 --help
dokos get-list "User" --limit 5
La première commande affiche l'aide et la liste des commandes disponibles. La seconde nécessite une configuration valide vers un site.
Mises à jour
dokos vérifie au plus une fois par jour si une nouvelle version publiée existe sur GitLab et affiche un message discret le cas échéant.
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)
La mise à jour s'adapte à la méthode d'installation :
| Installation | Comportement de dokos self-update |
|---|---|
| pipx | pipx install --force |
| pip | pip install -U |
| éditable (développement) | jamais modifiée — affiche seulement les étapes git pull |
La détection de version interroge un dépôt privé : exportez
GITLAB_TOKEN, ou enregistrez un jeton via dokos configure.