Verificado com neurobrix 0.6.15 (o analisador da linha de comandos na tag v0.6.15, cuja referência gerada é docs/reference/cli.md). Execute qualquer comando com --help para a lista de referência.
neurobrix --version # NeuroBrix v0.6.15
É obrigatório um subcomando. Comandos: run, serve, chat, stop, upscale, hub, import, list, remove, clean, info, inspect, validate, doctor.
Os comandos de desenvolvimento calibrate, autotune, drift e coverage são listados por neurobrix --help -v, não por neurobrix --help. Todos os comandos aceitam -v (as linhas de desenvolvimento do motor) e -vv (também o traceback de um erro).
| Código | Significado |
|---|---|
| 0 | Sucesso, --help e --version (doctor: nenhum problema bloqueante encontrado; validate: todos os ficheiros válidos) |
| 1 | Um erro, mostrado como Error: ... (algumas mensagens do import: ERROR: ...); doctor: problemas encontrados; validate: um ficheiro não é válido |
| 2 | Sem subcomando ou com uma opção desconhecida; hub: o registo rejeitou o pedido (por exemplo uma categoria desconhecida) |
| 130 | Interrompido com Ctrl+C |
O run sai com o estado diferente de zero da própria execução.
--json (em info, inspect, list, remove, import, hub, doctor, validate, e em run com --explain-plan) imprime um registo JSON no stdout e as linhas legíveis no stderr. import --json emite um evento JSON por linha.
Um modelo tem um só nome, o seu nome no hub org/Model (sensível a maiúsculas). O import regista esse nome junto do modelo instalado, e run, serve, upscale, inspect, remove e list usam-no; não existe um segundo nome curto. Um modelo instalado antes da 0.6.3 mantém o nome do diretório até neurobrix import org/Model ser executado uma vez para ele (nada é transferido de novo).
neurobrix import hexgrad/Kokoro-82M
neurobrix run --model hexgrad/Kokoro-82M --prompt "Hello" --speaker af_heart --output hello.wav
O Kokoro-82M fala inglês (léxico americano); escolha uma voz inglesa, por exemplo af_heart.
neurobrix hubNavegar no registo (não é preciso iniciar sessão).
| Opção | Descrição |
|---|---|
--category, -c |
Filtrar por categoria (convertida para maiúsculas por si) |
--search, -s |
Pesquisar por texto |
--registry |
URL do registo (por omissão https://neurobrix.org; as versões anteriores a 0.6.5 usam https://neurobrix.es, ainda servido) |
--json |
Saída legível por máquina |
neurobrix hub --category IMAGE
Uma categoria desconhecida mostra Error: unknown category '<value>' (valid categories: ...) (a lista vem do registo) e sai com 2. Os valores válidos estão em Hub de modelos.
neurobrix import ORG/NAMEDescarregar e instalar um modelo.
| Opção | Descrição |
|---|---|
--registry |
URL do registo |
--force |
Reinstalar um modelo que já está instalado |
--no-keep |
Apagar o .nbx descarregado após a extração (por predefinição é mantido em ~/.neurobrix/store/) |
--container FILE.nbx |
Instala a partir de um contentor que a máquina já tem, verificado em relação ao sha256 que o hub serve; nada é transferido |
--accept-license |
Aceitar uma licença com acesso restrito sem a pergunta |
--json |
Um evento JSON por linha |
neurobrix import hexgrad/Kokoro-82M
O que acontece, por ordem: o modelo é procurado (ERROR: Model 'org/name' not found on registry. se não existir), a licença é verificada, a transferência é pedida e recebida, o arquivo é verificado e depois extraído para ~/.neurobrix/cache/. A última linha é Installed org/name · run: <command>.
<file>.nbx.part. Execute o mesmo comando outra vez e retoma com um pedido HTTP Range.ERROR: not enough disk for this import). O pico de utilização é cerca de o dobro do tamanho do arquivo, a menos que passe --no-keep.org/name is already installed (--force re-downloads). e sai com 0, exceto com --force.Accept license terms? [yes/No]. Numa shell não interativa passe --accept-license ou defina NBX_ACCEPT_LICENSE=1, caso contrário: ERROR: license '<id>' requires explicit acceptance: re-run with --accept-license (saída 1). A aceitação é lembrada localmente. Veja Licenças.sha256sum) com o sha256 da API. Um contentor indicado com --container é verificado em relação a esse sha256 antes de tudo.| Comando | Descrição |
|---|---|
neurobrix list [--store] [--json] |
Modelos instalados, por nome (--store: também os arquivos transferidos) |
neurobrix remove MODEL [--store] [--all] [--json] |
Remover um modelo. Por predefinição remove apenas a cópia extraída; --store o arquivo, --all ambos |
neurobrix clean [--store] [--cache] [--all] [-y] |
Esvazia o store e/ou a cache. Sem nenhuma das três opções: Error: say what to wipe: --store (the .nbx archives), --cache (the installed models) or --all (saída 1) |
| Comando | Descrição |
|---|---|
neurobrix info [--models] [--hardware] [--system] [--json] |
Resumo do motor, dos modelos e do hardware |
neurobrix inspect PATH_OR_MODEL [--topology] [--weights] [--json] |
Olhar para dentro de um ficheiro .nbx ou de um modelo instalado |
neurobrix validate NBX... [--level LEVEL] [--strict] [--json] [-v] |
Verifica um ou mais ficheiros .nbx. Níveis (--level, -l): structure, schema, coherence (predefinido), deep. Saída 0 quando todos os ficheiros são válidos, 1 caso contrário |
neurobrix doctor [--json] |
Verifica a instalação: PATH, o motor Triton (versões do nbxtensor e do Triton), o PyTorch e a sua versão CUDA (opcional), as GPU que o processo vê |
O doctor sai com 0 e "No blocking problem found", ou com 1 e os problemas com a correção de cada um (1 também quando nenhum motor pode correr). PyTorch engine: not installed (optional; ...) só é bloqueante quando o motor Triton também não pode correr; a wheel do PyTorch que sugere depende da GPU (uma V100 recebe cu126). Com --json imprime {"schema", "engine", "ok": bool, "problems": [...]}. Em Apple Silicon indica a GPU Apple (Metal). Veja Instalar por hardware.
neurobrix runneurobrix run --model <org/name> --prompt "..." [options]
--model só pode ser omitido quando um daemon de serviço está a correr (Error: --model is required when no daemon is running.). Enquanto um daemon serve outro modelo, uma execução a frio é recusada (Error: a serving daemon is running (PID n) with another model, and NeuroBrix runs one task at a time.); com o mesmo modelo, a execução usa o daemon quente.
Opções comuns
| Opção | Descrição |
|---|---|
--hardware |
Perfil de hardware (detetado automaticamente se omitido) |
--explain-plan |
Mostra o plano de colocação e sai sem carregar nada |
--json |
Com --explain-plan: o plano como um único registo JSON |
--prompt |
Prompt de texto |
--output |
Ficheiro de saída. Predefinição output_<model>.<ext>; a extensão tem de corresponder à família do modelo |
--seed, --set KEY=VALUE |
Semente; substituir um valor predefinido do modelo (repetível) |
--certified-only |
Equivale a NBX_AUTOTUNE_CERTIFIED_ONLY=1 (também em calibrate e drift) |
--mode |
auto, text, chat, image, audio, video, t2i, img2img, inpainting, t2v, i2v, v2v |
Modo de execução (no máximo um; o predefinido é --compiled se o PyTorch estiver instalado, caso contrário --triton): --compiled, --sequential, --triton, --triton-sequential. Passar mais de um: Error: only one execution mode flag can be passed at a time (saída 1).
Por família
| Opção | Usada por |
|---|---|
--max-tokens, --temperature, --top-k, --top-p, --repetition-penalty, --system, --chat / --no-chat |
Modelos de linguagem |
--turns FILE |
Modelos de linguagem: uma lista JSON de mensagens do utilizador reproduzida como uma única sessão de chat, turno após turno |
--steps, --cfg, --height, --width |
Geração de imagem e vídeo |
--input-image, --mask-image |
Imagem para imagem, inpainting, visão-linguagem |
--num-frames, --fps, --input-video, --video |
Vídeo |
--audio |
Voz para texto, modelos de linguagem de áudio |
--speaker |
Texto para voz |
--reference-audio, --reference-image |
Não ligados nesta versão: recusados pelo nome |
Um primeiro comando para cada família
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
As entradas obrigatórias dependem da família. Uma em falta pára a execução com ZERO FALLBACK: family '<f>' requires <flag>. Provide it on the command line., e uma extensão de saída errada com ZERO FALLBACK: output extension '.x' incompatible with family .... Os modelos de visão-linguagem precisam de --prompt e --input-image; os modelos de linguagem de áudio precisam de --audio e --prompt; os modelos multimodais precisam de --mode text|image|audio.
Onde o reconhecimento de voz escreve a sua transcrição quando --output é omitido: ainda não documentado.
neurobrix upscaleneurobrix upscale --model <org/name> --input in.png --output out.png
| Opção | Descrição |
|---|---|
--model |
Obrigatória |
--input, --input-image |
Obrigatória, a imagem de origem |
--output |
Obrigatória, um caminho PNG |
--mode |
compiled (predefinido), sequential, triton, triton-sequential |
--hardware |
Perfil de hardware |
Uma entrada em falta mostra Error: input image not found: <path> (saída 1).
neurobrix serve --model <org/name> # load once
neurobrix run --prompt "..." # no --model needed
neurobrix chat # interactive, language models
neurobrix stop # shut it down
| Comando | Opções |
|---|---|
serve |
--model (obrigatório), --hardware, --timeout (segundos de inatividade, 1800 por omissão), --foreground, --http (serve também a API HTTP compatível com OpenAI, por omissão 127.0.0.1:8765), --http-host, --http-port, --api-key-file (obrigatório para um endereço que não seja loopback), --ready-fd / --ready-file (para um programa que lança o daemon: onde escrever o registo JSON de uma linha que indica que está pronto), opções de modo de execução |
chat |
--max-tokens, --temperature, --repetition-penalty. No chat: /new, /context, /status, /quit |
stop |
nenhuma; pede ao daemon que saia, depois termina-o se necessário e limpa os ficheiros residuais |
Se já existir um daemon, o serve mostra Error: a daemon is already running (PID n): neurobrix chat talks to it, neurobrix stop ends it e sai com 1. Uma tarefa de cada vez. Mais no Guia de serviço e em Serving and chat.
Seguinte: Configuração
© 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Ü