Aller au contenu

La version 0.1.0 est une première version, à l'essai. Voir ce qui n'est pas prouvé →

bogolang
EN

← Documentation

Les outils

Toutes les commandes bogo, avec bogo upgrade, et --replay, --dry, --record.

Toutes les pages de documentation

Cette page liste chaque commande bogo avec ses options, et dit exactement ce que font les options de sécurité --replay, --save-replay, --dry, --record et --yes. bogo --help et bogo COMMAND --help affichent les mêmes options dans le terminal.

Les commandes

Commande Ce qu'elle fait
bogo new NAME Créer un projet dans un nouveau dossier NAME
bogo run [OPTIONS] FILE [WORDS] Vérifier le fichier, puis l'exécuter
bogo FILE.bogo [WORDS] La forme courte de bogo run FILE.bogo
bogo check [--json] [--stdin NAME] [FILE] Vérifier un fichier sans l'exécuter
bogo test [-k WORD] [--now TIME] [FILE] Exécuter les tests ; rien n'est contacté
bogo shell [--replay FOLDER] [--record] Une invite interactive avec les noms intégrés prêts
bogo fmt [--check] [--stdin NAME] [FILES] Mettre en forme les fichiers .bogo
bogo doc [NAME] Afficher la référence d'un nom intégré
bogo vscode Installer l'extension Bogolang dans VS Code : voir vscode.md
bogo pack [--name NAME] [--icon FILE] FILE Créer un seul fichier à partager : le programme avec tout ce dont il a besoin
bogo add SPEC [--from FOLDER] Ajouter un paquet Python au projet
bogo remove NAME Retirer un paquet du projet
bogo sync [--from FOLDER] Refaire l'environnement du projet à partir de bogo.lock
bogo env Afficher l'environnement du projet
bogo engine list Lister les moteurs Python
bogo engine install VERSION [--from FILE] Ajouter un moteur
bogo engine use VERSION Utiliser un moteur pour ce projet
bogo login [PROFILE] Enregistrer les identifiants d'un équipement sur cet ordinateur
bogo logout [PROFILE] Supprimer des identifiants enregistrés
bogo version Afficher la version de Bogolang et de son moteur
bogo upgrade [--check] [--yes] Récupérer le Bogolang le plus récent, vérifier sa somme et l'installer
bogo uninstall [--yes] Retirer Bogolang de cette machine (Linux)

bogo run

Vérifie le fichier et, quand la vérification ne trouve aucune erreur, l'exécute. Le programme démarre dans main de la classe qui porte le nom du fichier (language.md). Les options se placent avant le nom du fichier. Les mots après le nom du fichier vont au programme, dans args.

bogo run --replay saved --dry change_vlan.bogo
bogo run report.bogo north 2027-01
bogo report.bogo north 2027-01
Option Ce qu'elle fait
--replay FOLDER Répondre à partir des sorties enregistrées dans FOLDER ; ne se connecter à aucun équipement et n'envoyer aucune sonde
--save-replay FOLDER Exécuter pour de vrai, et enregistrer chaque réponse dans FOLDER pour un --replay ultérieur
--dry Montrer ce que chaque bloc change enverrait, et n'en rien envoyer
--record À la fin, montrer chaque commande envoyée, avec son heure et son résultat
--record-file FILE Écrire ce journal dans un fichier CSV
--yes Répondre oui à chaque confirm()

Le code de sortie vaut 0 quand le programme se termine bien, 1 quand la vérification trouve une erreur, et le code du programme sinon.

bogo run prend ses options avant le fichier. Chaque mot après le fichier est donné au programme, dans ses args. Une option de bogo écrite après le fichier ne serait donc pas appliquée, et une exécution prévue sur des réponses enregistrées serait une exécution réelle. bogo refuse cela et n'exécute rien :

--replay stands after the file. There it is given to the program and bogo does not apply it.
Put it before the file, for example:  bogo run --replay saved --dry reach_hosts.bogo
Nothing was run. To give the program this very word, write it after --

Un programme qui prend pour lui-même un mot comme --dry le reçoit après -- : bogo run tool.bogo -- --dry.

Les options de sécurité

--replay FOLDER

Chaque commande qui atteindrait le réseau répond plutôt à partir d'un fichier dans FOLDER. Une commande sans réponse enregistrée échoue, et le message nomme le fichier dont elle a besoin.

Commande Où sa réponse est lue
Sessions sur équipement (show, run, backup, snapshot et les lecteurs) FOLDER/DEVICE/COMMAND.txt, un fichier par commande
snmp_get, snmp_walk FOLDER/DEVICE/snmp.txt
ping, ping_all, trace, tcping, resolve, scan FOLDER/reach/
http_get, Meraki, RESTCONF, inventory_api FOLDER/web/
on syslog, on trap, on netflow FOLDER/listen/ (aucun port n'est ouvert)

Lors d'une relecture, un bloc change ne se connecte à rien et ne change rien : ses lignes vont seulement dans le journal d'exécution. webhook(...) ne poste rien, et mail(...) affiche le courriel avec le mot REPLAY et n'envoie rien.

Les fichiers sont du texte brut, vous pouvez donc en écrire un à la main pour un essai. Les treize programmes de ../examples portent chacun leurs réponses enregistrées dans un dossier saved.

--save-replay FOLDER

Le programme s'exécute pour de vrai et contacte ce qu'il contacte. Chaque réponse est aussi enregistrée dans FOLDER, selon l'organisation ci-dessus. Une exécution ultérieure avec --replay FOLDER n'a alors besoin d'aucun équipement et d'aucun réseau. Lisez les fichiers enregistrés avant de les partager : ils contiennent ce que les équipements ont répondu.

--dry

Quoi Sous --dry
Un bloc change Affiche les lignes apply et rollback qu'il enverrait, et n'envoie rien
mail(...), webhook(...) Affichés, pas envoyés
Un bloc only between hors de sa fenêtre Sauté avec une ligne, là où il arrêterait le programme
dry_run() Donne True, pour que le programme puisse dire « serait ajouté » et non « ajouté »
Commandes en lecture seule (show, ping et les autres) Exécutées pour de vrai. Ajoutez --replay pour ne rien contacter du tout

Une exécution de l'exemple ../examples/change_vlan avec les deux options :

bogo run --replay saved --dry change_vlan.bogo
DRY RUN: change on core-sw1. Nothing is sent.
  apply:
    vlan 30
     name CAMERAS
    interface GigabitEthernet1/0/2
     switchport trunk allowed vlan add 30
  rollback:
    interface GigabitEthernet1/0/2
     switchport trunk allowed vlan remove 30
    no vlan 30
core-sw1: VLAN 30 would be added, nothing was sent
access-sw3: VLAN 30 is already there, nothing to do

Le programme interroge dry_run() pour sa dernière ligne :

Bogolang
done: str = "would be added, nothing was sent" if dry_run() else "added"
print(done)

--record et --record-file FILE

Chaque commande envoyée à un équipement, chaque commande de joignabilité et chaque alerte est une ligne du journal d'exécution : l'équipement, la commande, l'heure de début en heure locale et en UTC, la durée, si elle a fonctionné, et l'erreur. Les secrets n'y entrent jamais. --record l'affiche à la fin, sur le flux d'erreur ; --record-file FILE l'écrit en CSV.

bogo run --replay saved --record device_table.bogo
device      command       start_local                start_utc                  seconds  ok    error
core-sw1    show version  2026-11-20T18:07:16+01:00  2026-11-20T17:07:16+00:00  0.00     True
edge-rt2    show version  2026-11-20T18:07:16+01:00  2026-11-20T17:07:16+00:00  0.00     True
access-sw3  show version  2026-11-20T18:07:16+01:00  2026-11-20T17:07:16+00:00  0.00     True

--yes

confirm("question") demande oui ou non au clavier. Sans clavier, la réponse est non. Avec --yes, elle est oui, sans qu'aucune question soit posée.

bogo check

bogo check link_check.bogo
bogo check

Vérifie le fichier et les fichiers .bogo qu'il importe, et n'exécute rien. Dans un projet, sans fichier, il vérifie main.bogo avec les autres fichiers du projet. Il affiche FILE: no errors, ou chaque erreur avec sa ligne et sa colonne. Quand le programme contient des objets Untyped, il liste ensuite leurs lignes pour relecture. Code de sortie 0 ou 1.

bogo check ne demande pas de classe de départ : un fichier de bibliothèque passe.

bogo test

Forme Ce qu'elle exécute
bogo test Chaque fichier de test tests/test_*.bogo du projet
bogo test FILE Les tests d'un seul fichier
-k WORD Seulement les tests dont le nom affiché (TestClass.test_name) contient WORD
--now TIME Donne à chaque test cette heure, écrite comme 2027-01-15T10:00:00+01:00

Un test ne contacte rien. Chaque test s'exécute comme sous --replay, --dry et --yes à la fois. Les réponses enregistrées sont lues dans tests/replay dans un projet. Pour bogo test FILE hors d'un projet, elles sont lues dans le dossier replay à côté du fichier, ou saved quand il n'y a pas de replay. Une commande sans réponse enregistrée fait échouer son test. dry_run() vaut True dans un test.

Chaque fichier de test s'exécute dans un processus à lui. Un fichier de test qui contient une erreur n'est pas exécuté et compte comme échoué. Une erreur dans un fichier que les tests utilisent les arrête tous. Le code de sortie vaut 0 quand tous passent et 1 sinon.

bogo shell

Une invite interactive, avec chaque nom intégré prêt. Dans un projet, elle utilise les paquets du projet.

  • Chaque ligne passe par le lecteur, donc les littéraux fonctionnent : 192.0.2.0/24, 5min, -18.5dBm.
  • Les parenthèses peuvent être omises après une fonction intégrée et une espace : ping 192.0.2.1 est lu comme ping(192.0.2.1). Une ligne qui est déjà du Python valide est laissée telle quelle, donc summarize [a, b] est lu comme un indice, et échoue.
  • Une valeur est affichée quand la ligne n'est pas une affectation. Le dernier résultat est gardé dans _.
  • Les types ne sont pas vérifiés dans le shell.
  • Un bloc change est refusé. L'accès aux équipements est en lecture seule.
  • Le shell ne fonctionne pas à blanc : mail(...) tapé là envoie un courriel.
  • --replay FOLDER et --record fonctionnent comme pour bogo run.
  • exit ou la fin de l'entrée en sort. Ctrl+C arrête la ligne en cours, pas le shell.
>>> 1Gbps + 500Mbps
1.5Gbps
>>> n = 192.0.2.0/24
>>> n.split(26)
[Net("192.0.2.0/26"), Net("192.0.2.64/26"), Net("192.0.2.128/26"), Net("192.0.2.192/26")]
>>> 192.0.2.77 in n
True

Les fichiers .bogo d'un projet ne peuvent pas encore être importés dans le shell.

bogo fmt

Forme Ce qu'elle fait
bogo fmt Mettre en forme chaque fichier .bogo du projet (pas dans les dossiers dont le nom commence par un point)
bogo fmt FILE ... Mettre en forme ces fichiers
--check Ne rien changer ; lister les fichiers qui changeraient ; code de sortie 1 s'il y en a

Il repose sur Black, avec des lignes de 100 caractères et aucun autre réglage. Il ne change jamais ce que fait un programme : après la mise en forme, il compare le programme avant et après, et s'ils diffèrent en quoi que ce soit le fichier est laissé tel qu'il était, avec une phrase qui le dit. Un fichier qui contient une erreur de syntaxe est laissé tel qu'il était.

La ligne d'en-tête de chaque nouvelle instruction est laissée telle qu'elle est écrite ; seule son indentation suit. Tout l'intérieur d'un bloc change et d'un bloc rule n'est jamais touché. Un fichier garde ses fins de ligne.

bogo fmt --check change_vlan.bogo
change_vlan.bogo: would be tidied
1 file(s) would be tidied, 0 already tidy

bogo doc

bogo doc NAME affiche la signature et le texte d'un nom intégré, la même entrée que reference.md. bogo doc seul liste les noms. Un nom erroné donne les noms les plus proches :

bogo doc pingall
pingall is not a built-in name. Did you mean: ping_all, ping, tcping?

bogo pack

Crée un seul fichier qui s'exécute sur un autre ordinateur du même système, sans Bogolang ni Python sur celui-ci. Il repose sur PyInstaller, que le Bogolang installé embarque.

Forme Ce qu'elle fait
bogo pack FILE Vérifier le programme, puis créer le fichier dans le dossier dist
--name NAME Un autre nom pour le fichier (par défaut : le nom de FILE)
--icon FILE Votre propre icône (sous Windows un fichier .ico) ; sans elle, le fichier porte l'icône de Bogolang
  • Un programme qui contient une erreur n'est pas empaqueté.
  • Cela prend quelques minutes et produit un fichier d'environ 55 à 70 MB.
  • Un fichier créé sous Windows s'exécute sous Windows, un fichier créé sous Linux sous Linux.
  • Il contient le moteur, le programme, les commandes intégrées et les paquets du projet. Il ne contient jamais d'identifiants enregistrés, de jeton, de réglage de courriel ni de webhook.
  • Sous Linux, le constructeur a besoin des outils objdump et objcopy. Le Bogolang installé embarque les deux. Un Bogolang installé d'une autre manière les prend dans le système, et dit tout de suite quoi installer quand ils manquent.
  • Certains antivirus se méfient des programmes créés de cette manière.

Le fichier empaqueté prend d'abord les options de sécurité, puis les mots pour le programme :

Option Ce qu'elle fait
--dry, --replay FOLDER, --save-replay FOLDER, --record, --record-file FILE, --yes Comme pour bogo run
--login [PROFILE] Enregistrer les identifiants d'un équipement sur cet ordinateur-là, puis s'arrêter
--logout [PROFILE] Les supprimer, puis s'arrêter
--about Dire ce que contient le fichier, puis s'arrêter
--help-options Lister ces options

Projets et paquets

Commande Ce qu'elle fait
bogo new NAME Créer le dossier NAME avec bogo.toml, un main.bogo de départ et un tests vide
bogo add SPEC Installer un paquet dans l'environnement du projet et l'écrire dans bogo.toml et bogo.lock. SPEC est un nom, ou un nom et des versions : "netaddr>=1.3"
bogo remove NAME Le désinstaller et le retirer de bogo.toml
bogo sync Supprimer l'environnement et le refaire à partir de bogo.lock
--from FOLDER Pour add et sync : installer à partir de fichiers de paquets dans FOLDER, sans internet
bogo env Afficher le projet, son édition, son moteur, le Python de son environnement et ses paquets

L'environnement est le dossier .bogo du projet. Il voit les paquets de Bogolang lui-même, si bien qu'un nouveau projet ne télécharge rien. bogo.lock contient les paquets que le projet a ajoutés, à des versions exactes ; sa première ligne nomme la version de Bogolang. Les commandes qui ont besoin d'un projet le disent quand elles sont tapées hors d'un projet.

Moteurs

Commande Ce qu'elle fait
bogo engine list Lister les moteurs ; * marque celui du projet
bogo engine install 3.14 Télécharger ce moteur, le vérifier par rapport à sa somme SHA-256 publiée avant de décompresser quoi que ce soit, et le placer dans ~/.bogolang/engines
bogo engine install 3.14 --from FILE La même chose à partir d'un fichier apporté à la main ; ne contacte rien et affiche la somme du fichier pour que vous la compariez
bogo engine use 3.14 Utiliser ce moteur pour ce projet ; l'environnement est refait à la prochaine exécution

install.md en dit plus.

Identifiants

Les identifiants sont gardés dans le magasin protégé du système d'exploitation, jamais dans un fichier ni dans un programme. bogo login demande le nom d'utilisateur, puis le mot de passe et l'enable secret, qui ne s'affichent pas pendant la saisie.

Commande Ce qu'elle enregistre
bogo login [PROFILE] Les identifiants d'un équipement. Un équipement utilise le profil nommé dans la colonne login de sa ligne d'inventaire, ou default
bogo login --snmp [PROFILE] Des identifiants SNMP, version 2c (une communauté) ou 3 (un utilisateur). Un équipement utilise le profil de sa colonne snmp
bogo login --mail Les réglages du serveur de courriel pour mail()
bogo login --api PROFILE Un jeton ou une clé d'API. Un programme le nomme avec token="PROFILE"
bogo login --webhook PROFILE L'adresse d'un webhook, pour webhook("PROFILE", text)

bogo logout prend les mêmes options et supprime ce qui était enregistré.

bogo upgrade

bogo upgrade lit la version la plus récente, télécharge l'installateur de ce système, vérifie sa somme SHA-256 par rapport à celle qui est publiée et demande avant de lancer l'installateur. Les projets et les identifiants enregistrés sont conservés.

Option Ce qu'elle fait
--check Dire seulement si une version plus récente est publiée. Code de sortie 1 quand il y en a une
--yes Ne pas demander avant le lancement de l'installateur
  • Un fichier qui ne correspond pas à sa somme est supprimé et n'est jamais lancé.
  • Cela fonctionne pour un Bogolang mis en place par son installateur. Installé autrement, il le dit.
  • Il faut Internet. Sur un PC qui n'en a pas, copiez le nouvel installateur sur le PC et lancez-le : installer par-dessus une version plus ancienne la remplace.
  • Une entreprise qui garde sa propre copie des versions donne son adresse dans la variable d'environnement BOGO_RELEASES. L'adresse doit commencer par https://.

bogo version et bogo uninstall

bogo version affiche la version de Bogolang et du moteur, comme Bogolang 0.1.0, engine Python 3.15.

bogo uninstall retire un Bogolang mis en place par l'installateur Linux. Il demande d'abord ; --yes ne demande pas. Sous Windows, il dit de retirer Bogolang dans les paramètres de Windows, sous « Applications ». install.md dit ce que la suppression conserve.