CLI

Installez la version actuelle sur Linux ou macOS :

Les installations via Homebrew et depuis les sources Go sont également disponibles :

Sous Windows, téléchargez l’archive windows-amd64 ou windows-arm64 correspondante depuis la dernière version CLI, extrayez runapi.exe et ajoutez-le au PATH.

Épinglez l’installateur à une version ou à un répertoire d’installation lorsqu’un déploiement nécessite un binaire reproductible :

L’installateur accepte également RUNAPI_VERSION, RUNAPI_INSTALL_DIR, RUNAPI_INSTALL_BASE, RUNAPI_DOWNLOAD_BASE et RUNAPI_SKIP_LIBC_CHECK=1.

Sur un poste de travail, connectez-vous dans le navigateur et confirmez la source des identifiants :

Exécuter une action de modèle avec une entrée JSON en ligne ou un fichier JSON :

La plupart des actions de modèle sont asynchrones. Elles attendent un résultat terminal par défaut ; ajoutez --async pour retourner la tâche immédiatement et utilisez wait plus tard :

Chaque commande émet du JSON sur la sortie standard, sauf si une option demande explicitement une valeur scalaire, comme files create --url-only ou listen --print-secret. Les messages de progression et de diagnostic restent sur la sortie d’erreur standard, de sorte que le JSON peut circuler en toute sécurité vers jq :

Les actions du modèle acceptent exactement une source d’entrée de requête :

Utilisez runapi <service> <action> --help avant de construire une requête. La CLI installée liste les champs actuels de l’action, les identifiants de modèle acceptés et les contraintes de validation.

Ces options globales s’appliquent à chaque commande :

La forme de la commande de modèle est runapi <service> <action>. Les actions synchrones retournent leur réponse immédiatement. Pour les actions asynchrones, le comportement par défaut est de soumettre, d’interroger et de retourner le résultat terminal de la tâche ; --async retourne la réponse de création à la place.

Pour les champs d’URL de média de niveau supérieur, un chemin de fichier local lisible est téléversé avant l’exécution de l’action du modèle. Les URL http:// et https:// existantes sont envoyées sans modification. Utilisez files create lorsque vous avez besoin d’une URL temporaire réutilisable, lorsque la source est une URL distante ou lorsque la source est une donnée Base64.

La liste ci-dessus constitue l’inventaire complet des actions de cette version de la CLI. Le contrat exact de requête et de réponse de chaque action est disponible dans la Référence API, et l’aide de la commande locale est la source des champs propres à chaque version.

Utilisez get pour inspecter l’état actuel d’une Task asynchrone sans attendre. Utilisez wait pour interroger jusqu’à ce qu’elle se termine, échoue ou atteigne le délai d’expiration de la commande. Les deux commandes nécessitent le service et l’action d’origine afin que la CLI puisse sélectionner la forme de résultat de Task correcte.

runapi files create conserve le flux d’URL d’importation de fichier temporaire. Il importe un chemin local, une URL distante ou une source Base64 et retourne une URL qui expire après une heure.

Les sources sont mutuellement exclusives. --url-only affiche uniquement l’URL ; omettez cette option pour recevoir la réponse JSON complète.

Utilisez le cycle de vie de fichier persistant lorsque vous avez besoin d’un file_id stable plutôt que d’une URL :

content requiert --output ; passez - pour écrire les octets exacts du fichier sur la sortie standard. Consultez Files and Uploads pour connaître les limites, l’isolation de compte et le cycle de vie REST.

Utilisez les Uploads pour envoyer une ou plusieurs Parts avant de composer le File final. Create déclare le nombre d’octets final et les métadonnées ; répétez --part-id dans l’ordre de composition lors de la finalisation :

Inspectez l’utilisateur authentifié et le compte sélectionné, puis interrogez le solde et les compteurs de dépenses :

pricing list lit les grilles tarifaires en vigueur. Filtrez par service, action ou modèle. pricing quote estime la réservation de tâche pour un service et une action requis ; ajoutez --model lorsque l’action est spécifique à un modèle et fournissez les paramètres de tarification avec --params ou --params-file.

Les commandes de tarification ne nécessitent pas d’identifiants, sauf si le devis fait référence à une tâche source appartenant à un compte.

runapi login ouvre un flux d’autorisation dans le navigateur et enregistre les identifiants résultants. Pour les serveurs et les environnements CI, auth import-token accepte une clé API depuis l’entrée standard, la vérifie par défaut et l’enregistre sans exposer la valeur dans la liste des processus ou l’historique du shell :

auth import-token --skip-verify prend en charge la configuration hors ligne d’image. Utilisez-le uniquement lorsque la vérification ne peut pas s’exécuter pendant la configuration ; auth status vérifie les identifiants actifs ultérieurement.

La priorité de la clé API est --api-key, puis RUNAPI_API_KEY, puis le fichier de configuration CLI local. La priorité de la Base URL est --base-url, puis RUNAPI_BASE_URL, puis la Base URL enregistrée, puis https://runapi.ai. Le fichier de configuration est ~/.config/runapi/config.json, ou $XDG_CONFIG_HOME/runapi/config.json lorsque XDG_CONFIG_HOME est défini.

runapi listen reçoit les rappels de tâche pour une clé API sélectionnée et transfère éventuellement chaque rappel signé vers un point de terminaison HTTP local. Une connexion par navigateur est requise avant d’utiliser les opérations d’écoute.

L’URL positionnelle et --forward-to sont des alternatives. L’écouteur écrit chaque corps de callback signé sur la sortie standard. Une tâche avec callback_url continue de livrer à cette URL et est également copiée vers l’écouteur local.

Après réception d’un événement d’écoute valide, le CLI l’acquitte avant d’effectuer la requête HTTP locale. Chaque événement est transmis localement une seule fois : les réponses non-2xx et les erreurs de connexion sont signalées dans le terminal, mais elles ne déclenchent pas de relecture de l’événement par l’écouteur. Ce comportement de débogage local ne modifie pas les nouvelles tentatives de livraison pour le callback_url d’une tâche.

Chaque compte peut exécuter jusqu’à 100 écouteurs actifs par clé d’abonnement aux rappels et 1 000 écouteurs actifs au total. Lorsqu’une limite est atteinte, arrêtez un écouteur inactif ou attendez et réessayez. La réponse de l’API indique si la clé sélectionnée, votre compte ou la capacité globale du service est saturée.

Un écouteur inactif vérifie la présence de nouveaux événements toutes les 15 à 30 secondes environ. Les événements sont généralement trouvés en moins de 15 secondes et sont lus immédiatement lorsqu’ils sont disponibles. Si une limite est atteinte, arrêtez un écouteur inactif ou patientez et réessayez. Le comportement de livraison et d’acquittement existant reste inchangé.

La sélection de la clé s’effectue dans l’ordre suivant : --callback-api-key-id pour une seule commande, callback_api_key_id dans le fichier .runapi.toml du projet, puis un sélecteur interactif. La configuration du projet est enregistrée à la racine Git, ou dans le répertoire courant en dehors d’un dépôt Git, et ne contient que l’identifiant stable :

Affichez le secret de signature d’écoute d’une clé sélectionnée sans démarrer de listener, ou faites-le pivoter après exposition :

La rotation invalide les écouteurs actifs pour la clé sélectionnée. Mettez à jour chaque vérificateur local avec le nouveau secret affiché avant de redémarrer son écouteur.

Installez la compétence CLI RunAPI portable dans un Harness pris en charge, inspectez les cibles prises en charge ou supprimez une compétence installée :

Les cibles intégrées sont claude, codex, gemini, openclaw et hermes. install-skill accepte --version pour épingler une version de skill, --target-dir pour une destination personnalisée, --source pour un dépôt source, et --force pour écraser un répertoire de skill existant.

Générez des scripts de complétion pour Bash, Zsh, Fish ou PowerShell. Par exemple, chargez la complétion Bash dans le shell courant :

Utilisez runapi --help pour lister les commandes, runapi <command> --help pour les options d’une commande, et runapi <service> <action> --help pour les champs d’une action de modèle.

Les commandes se terminent avec un code non nul que les scripts peuvent gérer :

Pour les champs de requête, les valeurs de statut de tâche, les charges utiles de rappel, les corps d’erreur et la gestion des limites de débit, continuez avec la référence API . Utilisez les SDK lorsque le même flux de travail appartient à une application.