Vérifié sur neurobrix 0.6.15 (l'analyseur de la ligne de commande au tag v0.6.15, dont la référence générée est docs/reference/cli.md). Lancez n'importe quelle commande avec --help pour la liste qui fait foi.
neurobrix --version # NeuroBrix v0.6.15
Une sous-commande est requise. Commandes : run, serve, chat, stop, upscale, hub, import, list, remove, clean, info, inspect, validate, doctor.
Les commandes de développement calibrate, autotune, drift et coverage sont listées par neurobrix --help -v, pas par neurobrix --help. Chaque commande accepte -v (les lignes de développement du moteur) et -vv (en plus, le traceback d'une erreur).
| Code | Signification |
|---|---|
| 0 | Succès, --help et --version (doctor : aucun problème bloquant trouvé ; validate : tous les fichiers valides) |
| 1 | Une erreur, affichée comme Error: ... (certains messages d'import : ERROR: ...) ; doctor : problèmes trouvés ; validate : un fichier n'est pas valide |
| 2 | Aucune sous-commande ou un drapeau inconnu ; hub : le registre a rejeté la requête (par exemple une catégorie inconnue) |
| 130 | Interrompu avec Ctrl+C |
run sort avec le statut non nul de l'exécution elle-même.
--json (sur info, inspect, list, remove, import, hub, doctor, validate, et sur run avec --explain-plan) affiche un enregistrement JSON sur stdout et les lignes lisibles sur stderr. import --json émet un événement JSON par ligne.
Un modèle a un seul nom, son nom sur le hub org/Model (sensible à la casse). import enregistre ce nom à côté du modèle installé, et run, serve, upscale, inspect, remove et list l'utilisent ; il n'y a pas de second nom court. Un modèle installé avant 0.6.3 garde son nom de répertoire jusqu'à ce que neurobrix import org/Model soit lancé une fois pour lui (rien n'est retéléchargé).
neurobrix import hexgrad/Kokoro-82M
neurobrix run --model hexgrad/Kokoro-82M --prompt "Hello" --speaker af_heart --output hello.wav
Kokoro-82M parle anglais (lexique américain) ; choisissez une voix anglaise, par exemple af_heart.
neurobrix hubParcourir le registre (aucune connexion nécessaire).
| Drapeau | Description |
|---|---|
--category, -c |
Filtrer par catégorie (mise en majuscules pour vous) |
--search, -s |
Rechercher par texte |
--registry |
URL du registre (par défaut https://neurobrix.org ; les versions antérieures à 0.6.5 joignent https://neurobrix.es, toujours servi) |
--json |
Sortie lisible par machine |
neurobrix hub --category IMAGE
Une catégorie inconnue affiche Error: unknown category '<value>' (valid categories: ...) (la liste vient du registre) et sort avec le code 2. Les valeurs valides sont dans Hub de modèles.
neurobrix import ORG/NAMETélécharger et installer un modèle.
| Drapeau | Description |
|---|---|
--registry |
URL du registre |
--force |
Réinstaller un modèle déjà installé |
--no-keep |
Supprimer le .nbx téléchargé après l'extraction (par défaut il est conservé dans ~/.neurobrix/store/) |
--container FILE.nbx |
Installe depuis un conteneur que la machine détient déjà, vérifié par rapport au sha256 que sert le hub ; rien n'est téléchargé |
--accept-license |
Accepter une licence à accès conditionné sans l'invite |
--json |
Un événement JSON par ligne |
neurobrix import hexgrad/Kokoro-82M
Ce qui se passe, dans l'ordre : le modèle est recherché (ERROR: Model 'org/name' not found on registry. s'il est absent), la licence est vérifiée, le téléchargement est demandé et reçu en flux, l'archive est vérifiée, puis extraite dans ~/.neurobrix/cache/. La dernière ligne est Installed org/name · run: <command>.
<file>.nbx.part. Relancez la même commande et il reprend avec une requête HTTP Range.ERROR: not enough disk for this import). Le pic d'utilisation est d'environ deux fois la taille de l'archive, sauf si vous passez --no-keep.org/name is already installed (--force re-downloads). et sort avec 0, sauf avec --force.Accept license terms? [yes/No]. Dans un shell non interactif, passez --accept-license ou définissez NBX_ACCEPT_LICENSE=1, sinon : ERROR: license '<id>' requires explicit acceptance: re-run with --accept-license (code de sortie 1). L'acceptation est mémorisée localement. Voir Licences.sha256sum) avec le sha256 de l'API. Un conteneur fourni avec --container est vérifié par rapport à ce sha256 avant toute autre chose.| Commande | Description |
|---|---|
neurobrix list [--store] [--json] |
Modèles installés, par nom (--store : aussi les archives téléchargées) |
neurobrix remove MODEL [--store] [--all] [--json] |
Supprimer un modèle. Par défaut, supprime seulement la copie extraite ; --store l'archive, --all les deux |
neurobrix clean [--store] [--cache] [--all] [-y] |
Vide le store et/ou le cache. Sans aucune des trois options : Error: say what to wipe: --store (the .nbx archives), --cache (the installed models) or --all (code 1) |
| Commande | Description |
|---|---|
neurobrix info [--models] [--hardware] [--system] [--json] |
Résumé du moteur, des modèles et du matériel |
neurobrix inspect PATH_OR_MODEL [--topology] [--weights] [--json] |
Regarder à l'intérieur d'un fichier .nbx ou d'un modèle installé |
neurobrix validate NBX... [--level LEVEL] [--strict] [--json] [-v] |
Vérifie un ou plusieurs fichiers .nbx. Niveaux (--level, -l) : structure, schema, coherence (par défaut), deep. Code 0 quand tous les fichiers sont valides, 1 sinon |
neurobrix doctor [--json] |
Vérifie l'installation : PATH, le moteur Triton (versions de nbxtensor et de Triton), PyTorch et sa version CUDA (facultatif), les GPU que le processus voit |
doctor sort avec 0 et « No blocking problem found », ou avec 1 en listant les problèmes et la correction de chacun (1 aussi quand aucun moteur ne peut tourner). PyTorch engine: not installed (optional; ...) n'est bloquant que si le moteur Triton ne peut pas tourner non plus ; la wheel PyTorch proposée dépend du GPU (une V100 reçoit cu126). Avec --json, il affiche {"schema", "engine", "ok": bool, "problems": [...]}. Sur Apple Silicon, il signale le GPU Apple (Metal). Voir Installer selon le matériel.
neurobrix runneurobrix run --model <org/name> --prompt "..." [options]
--model ne peut être omis que lorsqu'un démon de service tourne (Error: --model is required when no daemon is running.). Pendant qu'un démon sert un autre modèle, une exécution à froid est refusée (Error: a serving daemon is running (PID n) with another model, and NeuroBrix runs one task at a time.) ; avec le même modèle, l'exécution utilise le démon chaud.
Options courantes
| Drapeau | Description |
|---|---|
--hardware |
Profil matériel (détecté automatiquement si omis) |
--explain-plan |
Affiche le plan de placement, puis sort sans rien charger |
--json |
Avec --explain-plan : le plan sous forme d'un enregistrement JSON |
--prompt |
Prompt texte |
--output |
Fichier de sortie. Par défaut output_<model>.<ext> ; l'extension doit correspondre à la famille du modèle |
--seed, --set KEY=VALUE |
Graine ; remplace une valeur par défaut du modèle (répétable) |
--certified-only |
Équivaut à NBX_AUTOTUNE_CERTIFIED_ONLY=1 (aussi sur calibrate et drift) |
--mode |
auto, text, chat, image, audio, video, t2i, img2img, inpainting, t2v, i2v, v2v |
Mode d'exécution (un au plus ; le défaut est --compiled quand PyTorch est installé, --triton sinon) : --compiled, --sequential, --triton, --triton-sequential. En passer plus d'un : Error: only one execution mode flag can be passed at a time (code 1).
Par famille
| Drapeau | Utilisé par |
|---|---|
--max-tokens, --temperature, --top-k, --top-p, --repetition-penalty, --system, --chat / --no-chat |
Modèles de langage |
--turns FILE |
Modèles de langage : une liste JSON de messages utilisateur jouée comme une seule session de chat, tour après tour |
--steps, --cfg, --height, --width |
Génération d'images et de vidéos |
--input-image, --mask-image |
Image vers image, inpainting, vision-langage |
--num-frames, --fps, --input-video, --video |
Vidéo |
--audio |
Parole vers texte, modèles de langage audio |
--speaker |
Synthèse vocale |
--reference-audio, --reference-image |
Pas branchés dans cette version : refusés nommément |
Une première commande pour chaque famille
neurobrix run --model <llm> --prompt "Explain ZFS in one paragraph" --max-tokens 256
neurobrix run --model <image> --prompt "a lighthouse at dusk" --steps 30 --output out.png
neurobrix run --model <video> --prompt "waves on a beach" --num-frames 33 --output out.mp4
neurobrix run --model <tts> --prompt "Hello" --speaker <voice> --output hello.wav
neurobrix run --model <stt> --audio speech.wav
neurobrix run --model <vlm> --prompt "Describe this" --input-image photo.png
Les intrants requis dépendent de la famille. Un intrant manquant arrête l'exécution avec ZERO FALLBACK: family '<f>' requires <flag>. Provide it on the command line., et une mauvaise extension de sortie avec ZERO FALLBACK: output extension '.x' incompatible with family .... Les modèles vision-langage nécessitent --prompt et --input-image ; les modèles de langage audio nécessitent --audio et --prompt ; les modèles multimodaux nécessitent --mode text|image|audio.
L'endroit où la parole vers texte écrit sa transcription quand --output est omis n'est pas encore documenté.
neurobrix upscaleneurobrix upscale --model <org/name> --input in.png --output out.png
| Drapeau | Description |
|---|---|
--model |
Requis |
--input, --input-image |
Requis, l'image source |
--output |
Requis, un chemin PNG |
--mode |
compiled (par défaut), sequential, triton, triton-sequential |
--hardware |
Profil matériel |
Une entrée manquante affiche Error: input image not found: <path> (code 1).
neurobrix serve --model <org/name> # load once
neurobrix run --prompt "..." # no --model needed
neurobrix chat # interactive, language models
neurobrix stop # shut it down
| Commande | Drapeaux |
|---|---|
serve |
--model (requis), --hardware, --timeout (secondes d'inactivité, 1800 par défaut), --foreground, --http (sert aussi l'API HTTP compatible OpenAI, par défaut 127.0.0.1:8765), --http-host, --http-port, --api-key-file (requis pour une adresse autre que la boucle locale), --ready-fd / --ready-file (pour un programme qui lance le démon : où écrire l'enregistrement JSON d'une ligne qui signale qu'il est prêt), options de mode d'exécution |
chat |
--max-tokens, --temperature, --repetition-penalty. Dans le chat : /new, /context, /status, /quit |
stop |
aucun ; demande au démon de quitter, puis le termine si nécessaire, et nettoie les fichiers résiduels |
Si un démon existe déjà, serve affiche Error: a daemon is already running (PID n): neurobrix chat talks to it, neurobrix stop ends it et sort avec 1. Une tâche à la fois. Plus de détails dans le Guide du service et Serving and chat.
Suivant : Configuration
© 2025–2026 Hocine Benkelaya. NeuroBrix engine released under the Apache License 2.0.
Developed by Hocine Benkelaya · Supported and funded by Neural Network Holding Ltd · Commercial distribution by WizWorks OÜ