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

Commandes

Référence des commandes Dokos CLI — lecture, rapports, schéma, écriture, appel de méthodes serveur — et les trois modes de sortie (tableau, JSON, JSON brut).

Toutes les commandes s'exécutent sur le site actif (voir la configuration). Chaque commande de données peut produire trois formats de sortie.

Modes de sortie

Option	Sortie	Quand l'utiliser
(aucune)	Tableau enrichi dans le terminal	lecture par un humain
`--json`	`{"data": [...], "next": [...]}` avec des commandes de suivi suggérées	enchaînement d'outils / usage par un agent
`--quiet`	JSON brut uniquement	redirection vers `jq` ou un script

dokos get-list "Item" --quiet | jq '.[].item_code'

Lecture

Commande	Rôle
`dokos get-list <DocType>`	Liste paginée de documents
`dokos get <DocType> <nom>`	Un document complet
`dokos get-count <DocType>`	Nombre de documents (avec filtres)
`dokos get-value <DocType> <champ>`	Un ou plusieurs champs d'un document
`dokos get-single-value <DocType> <champ>`	Un champ d'un DocType Single (paramètres globaux)

dokos get-list "Sales Invoice" \
  --filters '[["status","=","Overdue"]]' \
  --fields '["name","customer","grand_total"]' --json

dokos get "User" "Administrator"

Rapports

Commande	Rôle
`dokos run-report <nom>`	Exécuter un Query Report et renvoyer ses lignes
`dokos report list`	Lister les rapports
`dokos report get <nom>`	Détails d'un rapport
`dokos report run <nom>`	Exécuter un rapport
`dokos report create`	Créer un Query Report à partir de SQL

dokos run-report "Accounts Receivable" --filters '{"company":"Dokos SAS"}'

Schéma et permissions

Commande	Rôle
`dokos meta get <DocType>`	Schéma compact (champs + indicateurs)
`dokos perms get <DocType>`	Règles de permissions par rôle

dokos meta get "Sales Invoice"

Avant d'écrire, un dokos meta get permet de connaître les champs obligatoires et les options des champs Link / Select.

Écriture

Commande	Rôle
`dokos set-value <DocType> <nom> <champ> <valeur>`	Modifier un champ
`dokos insert`	Créer un document depuis un objet JSON
`dokos save`	Mettre à jour un document existant depuis un objet JSON
`dokos submit` / `dokos cancel`	Soumettre / annuler un document
`dokos delete`	Supprimer un document
`dokos rename`	Renommer un document
`dokos bulk-update`	Mise à jour en masse depuis un tableau JSON

dokos set-value "Task" "TASK-0001" status "Completed"

Les commandes d'écriture modifient des données réelles sur le site actif. Les droits utilisés sont ceux de l'utilisateur dont proviennent la clé et le secret d'API.

Appel de méthode serveur (RPC)

dokos call invoque n'importe quelle méthode serveur whitelistée par son chemin pointé :

dokos call frappe.client.get_count --args '{"doctype":"Task"}'

Chaque commande de données répond à un indicateur caché --agent qui décrit son contrat (commande, description, arguments, options, pièges) au format JSON. C'est ce que les agents utilisent pour s'auto-documenter :

dokos get-list --agent