Documentation
Référence des commandes rzv
Les commandes de rzv 0.21.0, regroupées selon ce sur quoi elles agissent. Chaque commande accepte --help, et chaque commande sauf rzv sandboxes ssh accepte --json.
Lire ces exemples
Installez la CLI, connectez-vous et sélectionnez un espace de travail avant d'utiliser les commandes liées à un espace de travail. Remplacez les valeurs entre chevrons, comme <job-id>, par vos propres identifiants avant d'exécuter un exemple. Ce sont des exemples de commandes, pas des sorties capturées.
Commencez par help pour voir chaque argument et chaque option. La plupart des commandes acceptent --json. Sandbox exec diffuse des événements JSON plutôt qu'un seul objet ; sandbox ssh est interactif et n'accepte pas --json.
rzv help
rzv help workspaces
rzv help sandboxesEspaces de travail et accès
Listez les espaces de travail auxquels vous appartenez, sélectionnez-en un, puis consultez ses paramètres, ses membres, ses invitations et ses équipes. L'API applique votre rôle et vos permissions pour chaque opération. rzv accounts est un ancien alias de workspaces.
- Settings update modifie le nom ou le logo d'un espace de travail. Les commandes de membres et d'invitations gèrent les rôles et les accès ; les commandes d'équipe gèrent les permissions et l'appartenance des équipes.
- Les demandes de fermeture demandent au personnel de fermer un espace de travail, ou retirent une demande en attente. Rien n'est supprimé immédiatement.
rzv workspaces list
rzv workspaces select <workspace-id>
rzv workspaces settings show
rzv workspaces members list
rzv workspaces invitations list
rzv teams list
rzv permissionsCréer un espace de travail
Remplacez <slug> par le slug du nouvel espace de travail et <name> par son nom d'affichage. La création sélectionne aussi l'espace de travail. Cette commande modifie votre compte ; elle n'est pas nécessaire si vous appartenez déjà à un espace de travail.
rzv workspaces create --slug <slug> --name "<name>"Tâches, exécuteurs et utilisation
Listez les tâches, puis utilisez l'identifiant d'une tâche retournée pour consulter son état et ses journaux. Status est un alias de get. Utilisez l'identifiant d'un dépôt pour voir les étiquettes d'exécuteur qu'il peut utiliser.
rzv jobs list
rzv jobs get <job-id>
rzv jobs status <job-id>
rzv jobs logs <job-id>
rzv runner-profiles <repository-id>
rzv runners <repository-id>
rzv usage
rzv concurrencyInsights
Consultez les totaux de tâches et de minutes enregistrées, l'activité de la file par heure UTC et les flux de travail les plus lents. Utilisez --days pour une période de 1 à 90 jours UTC.
rzv insights summary --days 7
rzv insights heatmap --days 7
rzv insights slow-jobs --days 7Agent Sandboxes
Listez les bacs à sable et les tailles offertes, puis créez un bac à sable pour l'exécution de commandes ou pour un terminal interactif. Start, stop et delete contrôlent son cycle de vie. Exec exécute des commandes ; ssh ouvre un terminal ; terminal-ticket prend en charge votre propre client de terminal.
rzv sandboxes list
rzv sandboxes get <sandbox-id>
rzv help sandboxesBientôt disponible : exemples de SSH standard, d'éditeurs et de transfert de fichiers
Bientôt disponible : exemple détaillé de transfert rsync
GitHub
Consultez les installations de l'application GitHub liées et les dépôts qu'elles couvrent. Utilisez connect pour commencer à lier une installation. Utilisez l'état et les identifiants d'installation retournés pour authorize ; n'inventez pas d'état de lien et ne réutilisez pas un état expiré. GitHub demande sa propre autorisation au besoin.
rzv github status
rzv github installations
rzv repositories list
rzv github connectTerminer une connexion à GitHub
Remplacez chaque marqueur par la valeur de votre connexion en cours. Demandez à une personne administratrice ou propriétaire de l'organisation d'effectuer cette étape si vous n'avez pas l'autorité d'installation.
rzv github authorize --state <state> --installation-id <id> --github-client-id <id>Facturation
Consultez le solde de minutes, les forfaits de crédits et la disponibilité du paiement, les achats récents de forfaits de minutes, les reçus et les factures. Auto-recharge et country affichent leurs paramètres actuels.
Le paiement par carte n'est offert que pour les espaces de travail facturés au Canada ou aux États-Unis. Checkout démarre un parcours d'achat ; utilisez l'identifiant du forfait tiré de billing et réutilisez le même identifiant d'opération lors d'une nouvelle tentative. La commande portal affiche un lien vers le portail de facturation du fournisseur de paiement.
rzv billing
rzv billing purchases
rzv billing invoices
rzv billing auto-recharge
rzv billing countryDémarrer un paiement
Cette commande démarre un paiement par carte pour l'espace de travail sélectionné. Utilisez vos propres identifiants de forfait et d'opération.
rzv billing checkout --pack <id> --operation-id <id>
rzv billing portalClés d'API
Consultez les clés existantes de l'espace de travail avant d'en créer une. Le secret d'une nouvelle clé n'apparaît qu'une fois, à la création. Les clés expirent après 365 jours, à moins que --expires-at ne soit plus rapproché. La gestion des clés d'API exige votre propre identité connectée et ne peut pas utiliser RZV_API_KEY.
rzv api-keys list
rzv help api-keysCréer ou révoquer une clé d'API
Utilisez --permissions <p,...> pour des permissions précises, ou --scopes <scope,...> pour des portées. Accordez à la clé uniquement l'accès dont votre script a besoin. Enregistrez son secret de façon sécurisée lorsqu'il est retourné ; ne le mettez pas dans le code source ni dans des messages au soutien.
rzv api-keys create --name "<name>" --permissions <permission,...> --idempotency-key <key>
rzv api-keys rename <key-id> --name "<name>"
rzv api-keys revoke <key-id>Utiliser une clé d'API dans un script
Fournissez RZV_API_KEY par votre script ou par le magasin de secrets de votre CI. Passez --workspace <id> ou définissez RZV_WORKSPACE avec l'identifiant de l'espace de travail ; une clé ne peut pas rechercher des slugs. Ne collez jamais le secret d'une clé dans ces exemples.
Les commandes qui exigent votre propre connexion refusent RZV_API_KEY : whoami ; workspace list, select et create ; l'acceptation d'invitations ; la gestion des clés d'API ; les notifications ; les billets personnels ; la liaison à GitHub ; les changements de fournisseur d'IA ; et les mises à jour des paramètres d'IA.
rzv jobs list --workspace <workspace-id> --jsonNotifications, activité et soutien
Les notifications exigent votre propre connexion. Consultez la boîte de réception et ses paramètres de livraison, examinez l'activité de l'espace de travail ou listez les billets de soutien. Ajoutez --personal pour les billets hors d'un espace de travail.
Les commandes de notifications marquent aussi les messages comme lus et modifient la livraison dans l'application ou par courriel. L'activité prend en charge l'exportation CSV et l'état de l'audit. Les commandes de billets ouvrent, affichent, commentent et ferment des billets ; consultez l'aide de la commande pour ses arguments obligatoires.
Les commandes de fournisseurs d'IA, de paramètres et d'utilisation gèrent les connexions d'IA de l'espace de travail. Pipelines et AI Fix n'apparaissent que s'ils sont activés pour votre espace de travail.
rzv notifications list
rzv notifications settings show
rzv activity list
rzv activity status
rzv tickets list
rzv help tickets
rzv help ai