Utilisation de l’interface de ligne de commande Bonsai

Syntax

bonsai [OPTIONS] COMMAND [ARGS]

Commandes

Commandes prises en charge :

  • brain : créer, gérer, former et évaluer des cerveaux.
  • configure : configurez vos ressources Bonsai et les authentifier auprès du serveur Bonsai.
  • simulator: travailler avec des simulateurs non gérés et des packages de simulateur géré.
  • help : afficher les informations d’utilisation et quitter.

Pour afficher le menu d’aide dans l’outil pour une commande donnée, utilisez l’indicateur --help avec la commande. Par exemple :

$ bonsai brain --help
Usage: bonsai brain [OPTIONS] COMMAND [ARGS]...

  Brain operations.

Options:
  -h, --help  Show this message and exit.

Commands:
  create   Create a brain.
  delete   Delete a brain.
  list     List brains owned by current user.
  show     Show information about a brain.
  update   Update information about a brain.
  version  Brain version operations.

Options de l’interface de ligne de commande

Vous pouvez utiliser les options suivantes pour configurer globalement l’interface de ligne de commande ou pour remplacer l’option de configuration actuelle pour une commande spécifique.


-v | --version

Affiche la version installée de l’interface de ligne de commande, puis recherche les mises à jour.

Exemple : bonsai --version


-s | --sysinfo

Affiche des informations sur l’environnement utilisateur, à savoir :

  • Système d’exploitation
  • Disponibilité du package et de l’environnement Python
  • Chemin d’accès du fichier de configuration de l’interface de ligne de commande
  • ID de l’espace de travail configuré
  • ID du locataire configuré
  • URL de l’API et de la passerelle

Exemple : bonsai --sysinfo


-t TIME_IN_SECONDS | --timeout TIME_IN_SECONDS

Entier.

Définit le délai d’expiration des commandes de l’interface de ligne de commande.

Par défaut : 300 secondes (5 minutes)

Exemple : bonsai --timeout 150


--enable-color | --disable-color

Active (--enable-color) ou désactive (--disable-color) la mise en évidence de la syntaxe en couleur pour la sortie de l’interface de ligne de commande.

Par défaut : couleur activée

Exemple : bonsai --enable-color


-dv | --disable-version-check

Indique à l’interface de ligne de commande de ne pas rechercher de nouvelles versions lors de l’exécution de commandes.

Par défaut : valeur non définie

Exemple : bonsai --disable-version-check


-h | --help

Affiche le menu d’aide principal de l’interface de ligne de commande, puis quitte

Exemple : bonsai --help

Exemples

Définir un délai d’expiration global pour toutes les commandes de l’interface de ligne de commande :

$ bonsai --timeout 90

Remplacer le paramètre global pour une commande spécifique :

bonsai --timeout 180           \
  brain version update-inkling \
  --name 'HiveMind'            \
  --file './bees.ink'          \
  --version 3
Uploaded ./bees.ink to HiveMind version 3.

ID de ressource

Vous pouvez configurer l’interface de ligne de commande pour utiliser des ID d’espace de travail Bonsai et des ID de locataire Azure spécifiques avec la commande configure.

Pour trouver les ID de vos ressources :

  1. Ouvrez l’interface utilisateur Bonsai.
  2. Cliquez sur votre e-mail d’utilisateur pour ouvrir le menu des paramètres du compte.
  3. Cliquez sur Workspace info (Informations sur l’espace de travail).
  4. Copiez les clés de ressource pour l’« ID d’espace de travail » ou l’« ID de locataire ».

Conseil

Vous pouvez modifier vos espace de travail et locataire par défaut à tout moment en réexécutant la commande configure.