Documentation
Everything Orazaka does, as it is built.
Generated from the code of the Orazaka repositories: module map, request pipeline, packs and Studios, the API, administration and the CLI.
Getting started
- Getting StartedStand up Orazaka locally and run your first request in minutes. This onboarding guide is for developers evaluating the engine or wiring it into an application.
- CLIOne tool for the whole platform: npx orazaka install, start, dev and you are running — then test, build these docs, install packs, seed the demo. Every command, subcommand and option, generated from the CLI's code.
- Mobile AppThe Orazaka app for iOS and Android as it runs today, on the iOS simulator and the Android emulator against the local stack: sign-in, Studios, streamed chat, jobs — how to run it, its tests, and which screens do not read the server yet.
Architecture
- Architecture OverviewHow Orazaka is built: a Ports & Adapters (hexagonal) engine, every module in its ring. The map and the messaging topology below are drawn from the same generated model as the tables that follow — select a module to see what it depends on.
- Core Engine & PipelineThe orchestration core and the request pipeline that every interaction flows through. For developers who want to understand how a prompt becomes a validated answer.
- RepositoriesOrazaka is one GitHub repository per component — users, notifications, billing, the AI engine, the UI kit… This map, generated from the workspace manifest, shows what each repository holds and what it depends on, so you can reuse only what your application needs.
- Supported AI ModelsThe models Orazaka has been tested with — local (Ollama) and optional hosted providers. Useful when deciding what you can run entirely on your own infrastructure.
- Business LayerWhere a request becomes business: the Intention, the use-cases that serve it, the dispatcher that checks who may run what, and where each piece lives (ports & adapters). Generated from orazaka-business.
- Interceptor RegistryEvery cross-cutting interceptor in the cognitive pipeline and its DB-driven order — generated from the code. For developers reasoning about how a request is enriched, routed and validated.
Core features
- Packs & StudiosThe business offers Orazaka installs without code: each pack, who it serves, its Studios and what they do — then how to install one and how to write your own. Generated from the orazaka-packs repository.
- AuthenticationHow identity, sessions and access control work in Orazaka. For developers securing a deployment.
- Business Implementation PlaybookA practical playbook for turning Orazaka capabilities into outcomes for a business — what to deploy, in what order, and what it delivers. Written for decision-makers, not just engineers.
- Use-Cases (technical)The technical entry points of the engine (App-Factory use-cases), generated from the Java code. Not the business offers: those are the packs and their Studios — see Packs & Studios.
- Tools & MCPWhat a model may call during a turn: the registered tools, when they are attached, the tool cache, the MCP servers (platform and per user) and the sandbox that isolates tools which write. Generated from orazaka-tools.
- Jobs, Schedules & AutomationEverything that runs without a user waiting: the job plane and its executors, every scheduled task of the platform, the automation connectors and the CLI agent. Generated from the code.
API & contracts
- API ReferenceThe HTTP/GraphQL surface for integrating Orazaka into your product. For developers building against the engine.
- Interface ContractsInbound and outbound ports per module, extracted from the code — the contract surface between layers. For developers wiring adapters against the hexagonal core.
- Worker ProtocolThe AMQP contract a worker speaks to join the platform — bindings, envelopes, progress and failure semantics. For developers writing a native or polyglot worker.
Operations
Guidelines
- Governance RulesEvery architecture rule enforced at build time and the test suites that enforce it — generated from the governance kit. For contributors who want to know what the build will refuse.
- ADR LedgerThe Architecture Decision Records cited across the codebase — generated from the source. For developers who want the rationale behind the engine's structure.
- GlossaryPlain-language definitions of the terms used across these docs. A quick reference for anyone evaluating Orazaka.
- LicensingWhat the Apache-2.0 license covers across the Orazaka repositories, and what that means for your deployment.