Dokos CLI

Dokos CLI

Dokos CLI (`dokos`) est un outil en ligne de commande qui dialogue avec un site Dokos via l'API REST. Il sert aussi bien depuis un terminal que depuis un agent IA (Claude Code, agy, Vibe CLI, OpenCode) 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.

À 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, soumission, annulation, suppression, renommage, mise à jour en masse.
  • 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.

Deux modes d'utilisation

ModeCommentPour qui
TerminalCommandes dokos …, sortie en tableau, JSON structuré ou JSON brutAdministrateurs, développeurs, scripts
Agent (MCP)dokos mcp + dokos agent installAssistants IA qui lisent et mettent à jour le site en langage naturel

Prérequis

  • Python ≥ 3.11
  • pipx (recommandé) ou pip
  • Un site Dokos/Frappe accessible, avec une clé et un secret d'API — ou un bench local que dokos peut détecter automatiquement.
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

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