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.

Administrer

Dokos CLI

Dokos CLI (`dokos`) est un outil en ligne de commande qui dialogue avec un site Dokos via l'API REST, depuis un terminal ou depuis un agent IA grâce à son serveur MCP intégré.

dokos est un utilitaire en ligne de commande, léger, qui s'appuie sur l'API REST de Frappe/Dokos. Il permet de lire et d'écrire des données d'un site Dokos — consulter des DocTypes, exécuter des rapports, inspecter des schémas et des permissions, créer ou modifier des documents — directement depuis un terminal ou depuis un agent IA.

Le même outil expose un serveur MCP (dokos mcp) : les agents (Claude Code, agy, Vibe CLI, OpenCode) accèdent alors aux mêmes capacités sous forme d'outils, sans passer par le terminal.

      
flowchart LR
    subgraph Clients
        H(Terminal\nun humain)
        A(Agent IA\nClaude Code / agy / Vibe / OpenCode)
    end
    H -->|commandes dokos| CLI
    A -->|outils MCP| MCP
    subgraph dokos-cli
        CLI(dokos\nligne de commande)
        MCP(dokos mcp\nserveur MCP)
    end
    CLI -->|API REST| API(API REST\nFrappe / Dokos)
    MCP -->|API REST| API
    API --> S[(Site Dokos)]

À quoi sert `dokos`

Interroger un site : listes de documents, lecture d'un document, comptages, valeurs de champs, rapports.
Écrire des données : création, mise à jour, validation, annulation, modification d'un document annulé, suppression, renommage, mise à jour en masse, envoi de fichiers.
Explorer le modèle : schémas de DocTypes et permissions, cache local du catalogue.
Équiper un agent IA : enregistrer le serveur MCP et installer l'assistant Dokos dans vos runtimes d'agents en une commande.

dokos guide affiche une présentation de l'outil. Cette commande ne demande ni site ni identifiants.

Deux modes d'utilisation

Mode	Comment	Pour qui
Terminal	Commandes `dokos …`, sortie en tableau, JSON structuré ou JSON brut	Administrateurs, développeurs, scripts
Agent (MCP)	`dokos mcp` + `dokos agent install`	Assistants IA qui lisent et mettent à jour le site en langage naturel

Un agent qui tourne dans le cloud (claude.ai, application mobile) ne peut pas lancer dokos mcp. Il se connecte au serveur MCP distant du site, fourni par l'application Dokos AI. Voir Serveurs MCP.

Prérequis

Python ≥ 3.11
pipx (recommandé) ou pip
Un site Dokos accessible, avec une clé et un secret d'API, ou un bench local que dokos détecte.
Linux, macOS ou Windows. Les commandes dokos use-site et dokos setup appellent bench : elles fonctionnent seulement sous Linux et macOS.

Cette section décrit l'outil dokos-cli (terminal + MCP). Elle est destinée aux administrateurs, développeurs et intégrateurs. Elle ne concerne pas l'utilisation quotidienne de l'interface Dokos.

Pour commencer

Installation — installer dokos et le tenir à jour.
Configuration — connecter la CLI à un site Dokos.
Commandes — interroger et modifier les données.
Intégration avec les agents — brancher dokos sur Claude Code, agy, Vibe CLI et OpenCode.