Documentation
API

CLI Reference

For developers

Operate and script the engine from the terminal. For developers and operators automating Orazaka.

🤖 Generated from code by scripts/generate-docs.mjs — do not hand-edit. Run orazaka docs build to refresh.

Local dev workflow

The dev loop has two layers — start them in order:

  1. Infrastructure — orazaka start --mode dev brings up the Docker middleware (PostgreSQL+pgvector, Redis, RabbitMQ) and the native AI engines (Ollama, LocalAI, video worker). Inference runs natively on macOS Metal — never in Docker.
  2. Applications — orazaka dev spawns the Router (Spring Boot), Web client, Web admin and the Expo mobile server in parallel. Prefer to debug the backend in your IDE? Run RouterApplication from IntelliJ and start the rest with orazaka dev --skip-router.

orazaka start --mode full additionally builds/runs the Router JAR and the UI for a hands-off boot. Tear everything down with orazaka stop.

ℹ️ start manages infrastructure; dev manages application processes. They are complementary, not alternatives.

Commands

CommandDescription
orazaka agentManage Orazaka local executing agent
orazaka buildRegenerate docs/_generated/ from the code
orazaka chatExecute interactive REPL or single-shot chat
orazaka configInteractive configuration wizard — review and update .env variables
orazaka dbDatabase maintenance operations
orazaka devLaunch the full Orazaka application stack in parallel (9 services + Web, Admin, Mobile)
orazaka docsCode-driven documentation: build (generate) | sync (to the site)
orazaka doctorAdvanced system health check with automatic recovery suggestions
orazaka forgotRequest a password reset token via email
orazaka generateGenerate features, interceptors, connectors, and configurations
orazaka graphDisplay Operation Graph capability matrix
orazaka initInitialize workspace — detects existing projects, validates config, and fixes gaps
orazaka installSetup wizard — verify tools, install dependencies, and configure deployment topology
orazaka installedList the Studios you have installed
orazaka listList the bundles this deployment's pack sources offer
orazaka listenStart CLI agent listener and reverse tunnel
orazaka loginAuthenticate and cache JWT token
orazaka logsStream and browse service logs
orazaka mcpManage your private dynamic MCP server connections
orazaka modelsScan the host hardware and report which catalog models it can run
orazaka onboardFull clone-and-run onboarding: verify prerequisites, compile, smoke-test M2M handshake, and probe local AI runtimes
orazaka packValidate, install and publish pack bundles
orazaka profileDisplay authenticated user profile information
orazaka publishPut an installed bundle's pack and Studios on the shelf
orazaka recoverDiagnose and recover from common issues
orazaka registerRegister a new user account
orazaka resetReset account password using a valid reset token
orazaka runRun an installed Studio
orazaka settingsManage user settings and preferences
orazaka startStart Orazaka infrastructure — dev mode (Docker middleware + AI engines) or full mode (also Router + UI)
orazaka statusShow live status of all Orazaka services
orazaka stopTeardown the Orazaka infrastructure — containers, workers, and state
orazaka studioBrowse, install and run installable business workflows
orazaka syncCopy docs/ (+ generated) into the Krizaka site content tree
orazaka testRun the test pyramid: unit | it (Testcontainers) | e2e (hermetic)
orazaka validateCheck a bundle's manifest, and whether this platform can run it
orazaka verifyVerify account registration token
orazaka videoGenerate video from a text prompt

Options

orazaka build

Regenerate docs/_generated/ from the code

OptionDescription
--checkFail if any generated doc is stale (build gate), without writing

orazaka chat

Execute interactive REPL or single-shot chat

OptionDescription
-t, --textForce text chat mode
-i, --image <path>Analyze a poster image
-a, --audio <path>Analyze an audio clip
-g, --gen-imageGenerate an image
-s, --speechConvert text to speech
-m, --model <model>Specify AI model name
-v, --voice <voice>Specify voice name
-o, --save <path>Specific file path to save output media

orazaka config

Interactive configuration wizard — review and update .env variables

OptionDescription
-l, --listList all current configuration values
-c, --category <name>Jump directly to a specific category

orazaka db

Database maintenance operations

OptionDescription
-y, --yesSkip the destructive-action confirmation prompt

orazaka dev

Launch the full Orazaka application stack in parallel (9 services + Web, Admin, Mobile)

OptionDescription
--only <services>Launch only these services (comma-separated: edge,router,identity,automation,knowledge,job,billing,studio,notifications,web,admin,mobile)
--skip-edgeSkip the Edge gateway (strangler facade on :8088)
--skip-identitySkip the Identity service (:8083)
--skip-routerSkip the Router (Spring Boot) backend — run RouterApplication from your IDE instead
--skip-coreDeprecated alias for --skip-router
--skip-automationSkip the Automation service (AMQP on :8082)
--skip-knowledgeSkip the Knowledge service (:8084)
--skip-jobSkip the Job Orchestration service (:8090)
--skip-billingSkip the Billing service (:8095)
--skip-studioSkip the Studio service (:8096)
--skip-notificationsSkip the Notification service (:8097)
--skip-adminSkip Admin console
--skip-mobileSkip Expo mobile server
--skip-webSkip Web client
--skip-workersSkip the Python workers declared by worker.yaml

orazaka doctor

Advanced system health check with automatic recovery suggestions

OptionDescription
-q, --quietOnly show issues, suppress passing checks
--fixAttempt to auto-fix detected issues
-v, --verboseShow detailed diagnostic output

orazaka init

Initialize workspace — detects existing projects, validates config, and fixes gaps

OptionDescription
-f, --forceOverwrite existing configuration
-y, --yesNon-interactive mode with defaults
--skip-validationSkip diagnostic checks
--dir <path>Target directory (default: current directory)

orazaka install

Setup wizard — verify tools, install dependencies, and configure deployment topology

OptionDescription
--check-onlyRead-only: verify tool availability & versions, then exit (no .env / compose changes)
-y, --yesNon-interactive mode — skip install prompts

orazaka logs

Stream and browse service logs

OptionDescription
--service <name>Tail a specific service (router, ollama, media-worker, image-worker, ui)
--listList all available log files with sizes
--since <duration>Show logs from last N hours (e.g., 1h, 30m)
--tail <lines>Number of lines to show from end of file

orazaka mcp

Manage your private dynamic MCP server connections

OptionDescription
--auth-token <token>Optional authorization token/header

orazaka register

Register a new user account

OptionDescription
-l, --language <lang>BCP 47 language tag (e.g. en, ja)

orazaka run

Run an installed Studio

OptionDescription
-i, --inputs <pairs>Inputs as key=value,key2=a|b|c (pipes make a list)

orazaka start

Start Orazaka infrastructure — dev mode (Docker middleware + AI engines) or full mode (also Router + UI)

OptionDescription
--mode <mode>Startup mode: dev (default, infra + AI engines) or full (also Router + Next.js UI)
--only <service>Start only a specific service (postgres, redis, rabbitmq, ollama, localai, image-gen, media-worker)
--skip-healthSkip final health verification
--wait-timeout <ms>Timeout for service startup (default: 60000ms)
--allow-partialAllow partial startup (some services may fail)
--verboseShow detailed startup logs
--logsTail log files after startup

orazaka status

Show live status of all Orazaka services

OptionDescription
--jsonOutput status as JSON
--watchRefresh every 5 seconds

orazaka stop

Teardown the Orazaka infrastructure — containers, workers, and state

OptionDescription
--purgeAlso purge database data and upload directories
-y, --yesSkip confirmation prompts

orazaka validate

Check a bundle's manifest, and whether this platform can run it

OptionDescription
--offlineCheck the manifest's shape only, without asking the platform

orazaka video

Generate video from a text prompt

OptionDescription
-d, --duration <seconds>Duration of the video in seconds
-m, --model <model>Specify AI model name
-o, --output <path>Specific file path to save the video

Product overview →

On this page