Commandes en ligne de commande

Choisir une commande

Utilisez la ligne de commande pour construire les images, vérifier les prérequis et examiner le travail conservé. Écrivez les tâches d’agent en TypeScript et lancez-les avec Node.js, comme dans Votre première tâche.

• outpost doctorVérifie l’hôte, le fournisseur de sandbox et une image.
• outpost image buildConstruit l’image d’agent à partir de sa recette.
• outpost image removeSupprime l’image d’agent.
• outpost recovery inspectListe ce que .outpost conserve, en lecture seule.
• outpost recovery verifyContrôle un transfert conservé avant de le restaurer.
• outpost recovery restoreRestaure un transfert conservé dans un nouveau répertoire.
• outpost recovery pruneSupprime les anciennes données selon une politique de rétention.
• outpost --helpListe les commandes, ou les options d’une commande.

Dans un projet qui dépend de @elie-laloum/outpost, lancez npx outpost <commande>. Ailleurs, lancez npx @elie-laloum/outpost <commande>.

Options communes

Option	Commandes	Effet
-h, --help	Toutes	Affiche l’usage et les options, puis s’arrête.
--json	doctor, recovery	Écrit le rapport en JSON sur stdout.
-y, --yes	init	Accepte les valeurs par défaut sans poser de question.
--apply	restore, prune	Effectue la modification ; sans elle, simple aperçu.

Code de sortie	Signification
0	Succès. Les avertissements et contrôles ignorés de doctor sortent aussi avec 0.
1	Un contrôle a échoué, un rapport est incomplet ou la commande a échoué (message sur stderr).
130	Interruption par Ctrl+C, ou question d’init annulée.
143	Arrêt par SIGTERM.

outpost doctor

Vérifiez les outils de la machine et le fournisseur de sandbox choisi. Ajoutez --image pour vérifier aussi une image locale d’agent dans un conteneur temporaire.

outpost doctor [--sandbox-provider NAME] [--agent NAME] [--image NAME] [--json]

Option	Par défaut	Valeurs et effet
--sandbox-provider	docker	docker, podman, local, vercel, daytona.
--agent	codex	codex, claude, antigravity, copilot, kimi.
--image	Aucune	Vérifie aussi cette image locale dans un conteneur temporaire. Docker et Podman seulement.
--json	Désactivé	Rapport JSON.

Il sort avec 1 quand un contrôle échoue. Diagnostic explique le rapport.

outpost image build

Construisez l’image d’agent à partir de la recette du répertoire choisi. Sélectionnez Docker ou Podman et donnez à l’image le nom utilisé dans vos scripts.

outpost image build [--directory PATH] [--engine docker|podman] [--file PATH] [--image NAME] [--uid N] [--gid N]

Option	Par défaut	Valeurs et effet
--directory	Répertoire courant	Contexte de build contenant la recette.
--engine	docker	docker, podman.
--file	Dockerfile (Docker), Containerfile (Podman)	Chemin de la recette, relatif à --directory.
--image	outpost:<nom du répertoire>	Tag de l’image.
--uid, --gid	Vos identifiants d’utilisateur et de groupe (1000 sous Windows)	Identifiants de l’utilisateur de l’agent dans l’image.

La sortie du moteur s’affiche dans le terminal, puis la commande écrit build: <image>. Un build s’arrête au bout de 30 minutes.

outpost image remove

Supprimez l’image locale d’agent lorsque vous n’en avez plus besoin. Utilisez le moteur et le nom de l’image que vous souhaitez supprimer.

outpost image remove [--directory PATH] [--engine docker|podman] [--image NAME]

--directory, --engine et --image prennent les mêmes valeurs par défaut qu’avec image build. La commande écrit remove: <image>.

outpost recovery inspect

Examinez les workspaces, les transferts conservés et l’activité enregistrée dans le .outpost d’un dépôt. Cette commande lit l’inventaire sans le modifier.

outpost recovery inspect [--repository PATH] [--max-entries N] [--git] [--locks] [--resources] [--json]

Option	Par défaut	Valeurs et effet
--repository	Checkout du répertoire courant	Dépôt dont le .outpost est listé.
--max-entries	100000	Arrête l’inventaire après ce nombre d’entrées.
--git	Désactivé	Ajoute la branche, le HEAD et l’état modifié de chaque workspace.
--locks	Désactivé	Ajoute les PID et la propriété des verrous locaux.
--resources	Désactivé	Ajoute l’activité de sandbox enregistrée.
--json	Désactivé	Rapport JSON.

Il ne modifie rien. Il sort avec 1 quand l’inventaire est partiel.

outpost recovery verify

Vérifiez un transfert conservé avant de le restaurer. Vous pouvez comparer les sommes de contrôle et tester l’application de ses patchs dans un clone temporaire.

outpost recovery verify --directory TRANSFER [--checksums [--max-bytes N]] [--restorability --repository PATH] [--json]

Option	Par défaut	Valeurs et effet
--directory	Requis	Répertoire du transfert conservé.
--checksums	Désactivé	Compare les fichiers au manifeste de sommes de contrôle du transfert.
--max-bytes	1 Gio	Octets vérifiés par --checksums, qu’il requiert.
--restorability	Désactivé	Applique les patchs du transfert dans un clone temporaire de --repository.
--repository	Aucun	Checkout utilisé par --restorability ; les deux vont ensemble.
--json	Désactivé	Rapport JSON.

Il ne modifie aucun fichier. Il sort avec 1 quand un contrôle échoue ou reste incomplet.

outpost recovery restore

Restaurez l’état sauvegardé de la machine ou les modifications reçues de la sandbox dans un nouveau répertoire. Consultez d’abord le plan, puis ajoutez --apply lorsque vous êtes prêt à créer la copie.

outpost recovery restore --directory TRANSFER --repository PATH --destination NEW_PATH --side previous|incoming [--max-bytes N] [--apply] [--json]

Option	Par défaut	Valeurs et effet
--directory	Requis	Répertoire du transfert conservé.
--repository	Requis	Checkout auquel appartient le transfert.
--destination	Requis	Nouveau répertoire hors du dépôt ; il ne doit pas exister.
--side	Requis	previous (état de l’hôte avant synchronisation) ou incoming (modifications de la sandbox).
--max-bytes	1 Gio	Taille maximale acceptée pour le contenu conservé.
--apply	Désactivé	Crée la destination ; sans elle, affiche le plan.
--json	Désactivé	Plan ou résultat en JSON.

La copie restaurée est un checkout détaché. Le transfert reste en place ; examinez la copie avant de l’intégrer.

outpost recovery prune

Prévisualisez les suppressions choisies par votre politique de rétention JSON. Ajoutez --apply pour supprimer ces entrées après avoir examiné le plan.

outpost recovery prune --policy FILE [--repository PATH] [--apply] [--json]

Option	Par défaut	Valeurs et effet
--policy	Requis	Fichier de politique JSON, 64 Kio au plus (format).
--repository	Checkout du répertoire courant	Dépôt dont le .outpost est nettoyé.
--apply	Désactivé	Supprime les candidats ; sans elle, simple essai à blanc.
--json	Désactivé	Plan et résultat en JSON.

Il sort avec 1 quand l’inventaire est incomplet, que la taille projetée dépasse la limite de la politique, ou que --apply a dû garder un candidat. Les branches et les artefacts de récupération sont toujours conservés.

outpost init

Cette commande génère un projet d’exemple et, avec Docker ou Podman, prépare l’image. Le parcours recommandé dans Installation l’utilise pour construire l’image ; vous écrivez ensuite vos propres scripts TypeScript.

outpost init [--yes] [--directory PATH] [--repository PATH] [--agent NAME] [--sandbox-provider NAME] [options]

Dans un terminal, init demande l’agent, le fournisseur de sandbox, le gestionnaire de paquets et l’authentification que vous n’avez pas passés. Hors terminal, passez --yes, ou à la fois --agent et --sandbox-provider.

init écrit run.ts, brief.md, .env.example, .gitignore, la recette d’image et, s’il n’en existe pas, package.json (génération facultative de projet). Il s’arrête avant d’écrire si l’un de ces fichiers existe, sauf .gitignore, qu’il complète.

Il affiche ensuite les étapes de connexion propres à l’authentification choisie et la commande à lancer, par exemple node run.ts.

npx outpost init --yes --directory .outpost-image --image outpost:dev

Option	Par défaut	Valeurs et effet
--directory	Répertoire courant	Où le projet est écrit.
--repository	.	Checkout Git que modifie le workflow, relatif à --directory.
--agent	codex	codex, claude, antigravity, copilot, kimi.
--sandbox-provider	docker	docker, podman, local, vercel, daytona.
--authentication	account (usage avec --base-url)	account, usage ; account-token pour claude et copilot.
--model	Celui de la CLI	Nom du modèle. Requis pour Kimi en usage et avec --base-url.
--base-url	Aucun	Endpoint Responses Codex personnalisé. Requiert --model et usage.
--api-key-env	OPENAI_API_KEY	Variable de la clé pour --base-url.
--manager	Champ packageManager, lockfile, ou npm	npm, pnpm, yarn, bun.
--install	Désactivé	Installe @elie-laloum/outpost et le SDK du fournisseur en dépendances de dev.
--build, --no-build	Build pour docker et podman	Construit l’image une fois les fichiers écrits.
--image	outpost:<nom du répertoire>	Tag de l’image construite et utilisée par run.ts (Docker et Podman).

API : inspectRecovery · verifyRecoveryTransfer · planRecoveryRestore · restoreRecoveryTransfer · planRecoveryRetention · pruneRecoveryRetention.