Geprüft gegen neurobrix 0.6.15 (den Kommandozeilen-Parser am Tag v0.6.15, dessen generierte Referenz docs/reference/cli.md ist). Führe einen beliebigen Befehl mit --help aus, um die maßgebliche Liste zu sehen.
neurobrix --version # NeuroBrix v0.6.15
Ein Unterbefehl ist erforderlich. Befehle: run, serve, chat, stop, upscale, hub, import, list, remove, clean, info, inspect, validate, doctor.
Die Entwicklerbefehle calibrate, autotune, drift und coverage listet neurobrix --help -v, nicht neurobrix --help. Jeder Befehl akzeptiert -v (die Entwicklerzeilen der Engine) und -vv (zusätzlich den Traceback eines Fehlers).
| Code | Bedeutung |
|---|---|
| 0 | Erfolg, --help und --version (doctor: kein blockierendes Problem gefunden; validate: alle Dateien gültig) |
| 1 | Ein Fehler, ausgegeben als Error: ... (manche Meldungen von import: ERROR: ...); doctor: Probleme gefunden; validate: eine Datei ist ungültig |
| 2 | Kein Unterbefehl oder ein unbekanntes Flag; hub: Das Register hat die Anfrage abgelehnt (zum Beispiel wegen einer unbekannten Kategorie) |
| 130 | Mit Strg+C unterbrochen |
run endet mit dem von null verschiedenen Status des Laufs selbst.
--json (bei info, inspect, list, remove, import, hub, doctor, validate und bei run mit --explain-plan) gibt einen JSON-Datensatz auf stdout und die lesbaren Zeilen auf stderr aus. import --json gibt ein JSON-Ereignis pro Zeile aus.
Ein Modell hat genau einen Namen, seinen Hub-Namen org/Model (mit Groß- und Kleinschreibung). import legt diesen Namen neben dem installierten Modell ab, und run, serve, upscale, inspect, remove und list verwenden ihn; es gibt keinen zweiten, kurzen Namen. Ein vor 0.6.3 installiertes Modell behält seinen Verzeichnisnamen, bis neurobrix import org/Model einmal dafür ausgeführt wird (es wird nichts erneut heruntergeladen).
neurobrix import hexgrad/Kokoro-82M
neurobrix run --model hexgrad/Kokoro-82M --prompt "Hello" --speaker af_heart --output hello.wav
Kokoro-82M spricht Englisch (amerikanisches Lexikon); wählen Sie eine englische Stimme, zum Beispiel af_heart.
neurobrix hubDas Register durchsuchen (keine Anmeldung nötig).
| Flag | Beschreibung |
|---|---|
--category, -c |
Nach Kategorie filtern (wird für dich in Großbuchstaben umgewandelt) |
--search, -s |
Per Text suchen |
--registry |
Registry-URL (Standard https://neurobrix.org; Versionen vor 0.6.5 erreichen https://neurobrix.es, weiterhin bedient) |
--json |
Maschinenlesbare Ausgabe |
neurobrix hub --category IMAGE
Eine unbekannte Kategorie gibt Error: unknown category '<value>' (valid categories: ...) aus (die Liste kommt von der Registry) und endet mit 2. Die gültigen Werte stehen unter Modell-Hub.
neurobrix import ORG/NAMEEin Modell herunterladen und installieren.
| Flag | Beschreibung |
|---|---|
--registry |
Register-URL |
--force |
Ein bereits installiertes Modell neu installieren |
--no-keep |
Die heruntergeladene .nbx nach dem Entpacken löschen (standardmäßig bleibt sie in ~/.neurobrix/store/) |
--container FILE.nbx |
Installiert aus einem Container, den der Rechner schon hat, geprüft gegen den sha256, den der Hub liefert; es wird nichts heruntergeladen |
--accept-license |
Eine gesperrte Lizenz ohne Abfrage akzeptieren |
--json |
Ein JSON-Ereignis pro Zeile |
neurobrix import hexgrad/Kokoro-82M
Was passiert, der Reihe nach: Das Modell wird gesucht (ERROR: Model 'org/name' not found on registry., wenn es fehlt), die Lizenz wird geprüft, der Download wird angefordert und gestreamt, das Archiv wird geprüft und dann nach ~/.neurobrix/cache/ entpackt. Die letzte Zeile ist Installed org/name · run: <command>.
<file>.nbx.part. Führe denselben Befehl erneut aus, und er setzt mit einer HTTP-Range-Anfrage fort.ERROR: not enough disk for this import). Der Spitzenverbrauch beträgt etwa das Doppelte der Archivgröße, außer du übergibst --no-keep.org/name is already installed (--force re-downloads). aus und endet mit 0, außer mit --force.Accept license terms? [yes/No]. In einer nicht interaktiven Shell übergib --accept-license oder setze NBX_ACCEPT_LICENSE=1, sonst: ERROR: license '<id>' requires explicit acceptance: re-run with --accept-license (Exit 1). Die Zustimmung wird lokal gemerkt. Siehe Lizenzen.sha256sum) mit dem sha256 aus der API. Ein mit --container angegebener Container wird vor allem anderen gegen diesen sha256 geprüft.| Befehl | Beschreibung |
|---|---|
neurobrix list [--store] [--json] |
Installierte Modelle, nach Namen (--store: auch die heruntergeladenen Archive) |
neurobrix remove MODEL [--store] [--all] [--json] |
Ein Modell entfernen. Standardmäßig nur die entpackte Kopie; --store das Archiv, --all beides |
neurobrix clean [--store] [--cache] [--all] [-y] |
Leert den Store und/oder den Cache. Ohne eines der drei Flags: Error: say what to wipe: --store (the .nbx archives), --cache (the installed models) or --all (Exit 1) |
| Befehl | Beschreibung |
|---|---|
neurobrix info [--models] [--hardware] [--system] [--json] |
Zusammenfassung von Engine, Modellen und Hardware |
neurobrix inspect PATH_OR_MODEL [--topology] [--weights] [--json] |
In eine .nbx-Datei oder ein installiertes Modell hineinsehen |
neurobrix validate NBX... [--level LEVEL] [--strict] [--json] [-v] |
Prüft eine oder mehrere .nbx-Dateien. Stufen (--level, -l): structure, schema, coherence (Standard), deep. Exit 0, wenn alle Dateien gültig sind, sonst 1 |
neurobrix doctor [--json] |
Prüft die Installation: PATH, die Triton-Engine (Versionen von nbxtensor und Triton), PyTorch und seinen CUDA-Build (optional), die GPUs, die der Prozess sieht |
doctor endet mit 0 und "No blocking problem found" oder mit 1 und den Problemen samt Lösung (1 auch, wenn keine Engine laufen kann). PyTorch engine: not installed (optional; ...) ist nur dann ein blockierendes Problem, wenn auch die Triton-Engine nicht laufen kann; das vorgeschlagene PyTorch-Wheel hängt von der GPU ab (eine V100 bekommt cu126). Mit --json gibt es {"schema", "engine", "ok": bool, "problems": [...]} aus. Auf Apple Silicon meldet es die Apple-GPU (Metal). Siehe Installation nach Hardware.
neurobrix runneurobrix run --model <org/name> --prompt "..." [options]
--model darf nur weggelassen werden, wenn ein Serving-Daemon läuft (Error: --model is required when no daemon is running.). Solange ein Daemon ein anderes Modell bereitstellt, wird ein kalter Lauf abgelehnt (Error: a serving daemon is running (PID n) with another model, and NeuroBrix runs one task at a time.); mit demselben Modell nutzt der Lauf den warmen Daemon.
Allgemeine Optionen
| Flag | Beschreibung |
|---|---|
--hardware |
Hardware-Profil (automatisch erkannt, wenn weggelassen) |
--explain-plan |
Gibt den Platzierungsplan aus und endet dann, ohne etwas zu laden |
--json |
Mit --explain-plan: der Plan als ein JSON-Datensatz |
--prompt |
Text-Prompt |
--output |
Ausgabedatei. Standard output_<model>.<ext>; die Endung muss zur Modellfamilie passen |
--seed, --set KEY=VALUE |
Seed; einen Modell-Standardwert überschreiben (wiederholbar) |
--certified-only |
Wie NBX_AUTOTUNE_CERTIFIED_ONLY=1 (auch bei calibrate und drift) |
--mode |
auto, text, chat, image, audio, video, t2i, img2img, inpainting, t2v, i2v, v2v |
Ausführungsmodus (höchstens einer; Standard ist --compiled, wenn PyTorch installiert ist, sonst --triton): --compiled, --sequential, --triton, --triton-sequential. Mehr als einen anzugeben: Error: only one execution mode flag can be passed at a time (Exit 1).
Je Familie
| Flag | Verwendet von |
|---|---|
--max-tokens, --temperature, --top-k, --top-p, --repetition-penalty, --system, --chat / --no-chat |
Sprachmodelle |
--turns FILE |
Sprachmodelle: eine JSON-Liste von Nutzernachrichten, abgespielt als eine Chat-Sitzung, Runde für Runde |
--steps, --cfg, --height, --width |
Bild- und Videogenerierung |
--input-image, --mask-image |
Bild-zu-Bild, Inpainting, Vision-Language |
--num-frames, --fps, --input-video, --video |
Video |
--audio |
Sprache-zu-Text, Audio-Sprachmodelle |
--speaker |
Text-to-Speech |
--reference-audio, --reference-image |
In dieser Version nicht angebunden: werden namentlich abgelehnt |
Ein erster Befehl für jede Familie
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
Die erforderlichen Eingaben hängen von der Familie ab. Eine fehlende stoppt den Lauf mit ZERO FALLBACK: family '<f>' requires <flag>. Provide it on the command line., eine falsche Ausgabeendung mit ZERO FALLBACK: output extension '.x' incompatible with family .... Bild-Sprache-Modelle brauchen --prompt und --input-image; Audio-Sprachmodelle brauchen --audio und --prompt; multimodale Modelle brauchen --mode text|image|audio.
Wohin Sprache-zu-Text sein Transkript schreibt, wenn --output weggelassen wird, ist noch nicht dokumentiert.
neurobrix upscaleneurobrix upscale --model <org/name> --input in.png --output out.png
| Flag | Beschreibung |
|---|---|
--model |
Erforderlich |
--input, --input-image |
Erforderlich, das Quellbild |
--output |
Erforderlich, ein PNG-Pfad |
--mode |
compiled (Standard), sequential, triton, triton-sequential |
--hardware |
Hardware-Profil |
Eine fehlende Eingabe gibt Error: input image not found: <path> aus (Exit 1).
neurobrix serve --model <org/name> # load once
neurobrix run --prompt "..." # no --model needed
neurobrix chat # interactive, language models
neurobrix stop # shut it down
| Befehl | Flags |
|---|---|
serve |
--model (erforderlich), --hardware, --timeout (Leerlaufsekunden, Standard 1800), --foreground, --http (stellt zusätzlich die OpenAI-kompatible HTTP-API bereit, Standard 127.0.0.1:8765), --http-host, --http-port, --api-key-file (erforderlich für eine andere Adresse als Loopback), --ready-fd / --ready-file (für ein Programm, das den Daemon startet: wohin der einzeilige JSON-Bereitschaftsdatensatz geschrieben wird), Ausführungsmodus-Flags |
chat |
--max-tokens, --temperature, --repetition-penalty. Im Chat: /new, /context, /status, /quit |
stop |
keine; bittet den Daemon, sich zu beenden, beendet ihn bei Bedarf zwangsweise und räumt veraltete Dateien auf |
Gibt es bereits einen Daemon, gibt serve Error: a daemon is already running (PID n): neurobrix chat talks to it, neurobrix stop ends it aus und endet mit 1. Eine Aufgabe zur Zeit. Mehr in der Serving-Anleitung und unter Serving and chat.
Weiter: Konfiguration
© 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Ü