# Omnius

Omnius is a local-first runtime for AI-assisted software development and generative work. It brings a terminal interface, browser dashboard, automation API, agent execution, memory, and media tools into one workspace-oriented system.

Omnius connects to local and remote model providers. Projects retain their own sessions and generated artifacts, while model weights and runtime dependencies are shared across workspaces.

[![npm](https://img.shields.io/npm/v/omnius.svg)](https://www.npmjs.com/package/omnius)
[![Node](https://img.shields.io/badge/node-%3E%3D22-brightgreen.svg)](https://nodejs.org/)
[![License](https://img.shields.io/badge/license-CC--BY--NC--4.0-blue.svg)](https://creativecommons.org/licenses/by-nc/4.0/)

## Get started

Requires Node.js 22 or newer and npm 10 or newer.

```bash
npm install -g omnius
omnius
```

Use `/setup` to configure inference and `/help` to explore terminal commands. See [installation](docs/getting-started/install.md), [first run](docs/getting-started/first-run.md), and [model providers](docs/getting-started/model-providers.md) for setup details.

To open the browser dashboard and API:

```bash
omnius serve
```

The default dashboard address is `http://127.0.0.1:11435/`, with interactive API documentation at `/docs`.

## System overview

| Layer | Responsibility |
| --- | --- |
| Interfaces | Terminal sessions, browser workspaces, command-line automation, and system tray integration |
| Agent runtime | Task execution, tool use, delegated agents, verification, and resumable work |
| Inference | Model selection and routing across local servers, configured providers, and peers |
| Tools | Files, code, shell commands, web access, browser automation, and extensible capabilities |
| Memory and retrieval | Project context, indexed material, persistent memory, and targeted retrieval |
| Media and voice | Image, video, audio, music, speech recognition, and speech synthesis |
| Integration | REST APIs, events, MCP, Telegram, and shared inference services |

The [architecture overview](docs/architecture/overview.md) and [agent system map](docs/architecture/agent-system-map.md) describe the runtime boundaries and state ownership.

## Workspaces and sessions

A project provides the working directory for files, tools, conversations, and generated media. Terminal and browser interfaces expose saved sessions and project artifacts. Operational details remain available alongside the conversation without replacing its authored content.

Project state lives under `.omnius/`. Shared model weights and runtime dependencies are managed separately from project-generated media. See [terminal workflows](docs/guides/tui-workflows.md), the [dashboard guide](docs/guides/dashboard.md), and [media generation](docs/guides/media-generation.md).

## Automation and discovery

Omnius can run a task directly from the command line:

```bash
omnius "inspect this repository and explain its main entrypoints"
```

Agents and integrations can discover capabilities through the CLI or daemon:

```bash
omnius discover "bring your own inference"
omnius show layer.orchestration
omnius capabilities --json
```

The daemon provides stateful chat, agent execution, tools, memory, media, and OpenAI/Ollama-compatible inference interfaces. Begin with [agent integration](docs/guides/agent-integration.md) and the [discovery guide](docs/DISCOVERY.md).

<!-- BEGIN GENERATED REST INVENTORY -->
The complete API inventory is maintained in the [REST reference](docs/reference/rest-api.md). The running daemon serves its machine-readable contract at `/openapi.json`.
<!-- END GENERATED REST INVENTORY -->

## Documentation

| Topic | Guide |
| --- | --- |
| Inference configuration | [Provider protocols and keys](docs/guides/bring-your-own-inference.md) |
| Commands and tools | [Slash commands](docs/reference/slash-commands.md), [tool discovery](docs/guides/tools-and-web-search.md) |
| Agent coordination | [Adjudication](docs/ADJUDICATION.md), [agent system map](docs/architecture/agent-system-map.md) |
| Browser interface | [Dashboard](docs/guides/dashboard.md) |
| Voice and media | [Realtime voice](docs/guides/realtime.md), [media generation](docs/guides/media-generation.md), [Omni analysis](docs/reference/omni-analysis.md) |
| Connected services | [Telegram](docs/guides/telegram.md), [system tray](docs/guides/system-tray.md), [sponsor and peer inference](docs/guides/sponsor-and-cohere.md) |
| Runtime administration | [Runtime hygiene](docs/operations/runtime-hygiene.md), [access control](docs/operations/security-and-remote-access.md) |
| Agent-readable documentation | [Documentation index](docs/agent-memory/INDEX.md) |

## Development

The repository is a pnpm workspace. `packages/cli` contains the interfaces and daemon; `packages/orchestrator` coordinates agent execution; `packages/execution` provides tools. Supporting packages cover memory, indexing, retrieval, schemas, prompts, and backend integration.

Requires pnpm 9 or newer.

```bash
pnpm install
pnpm -r build
pnpm docs:check
```

Publishing uses the generated `publish/` package. The build, verification, and release procedure is documented in [AGENTS.md](AGENTS.md).

## License

Omnius is released under [CC-BY-NC-4.0](https://creativecommons.org/licenses/by-nc/4.0/) for non-commercial use. Commercial use, redistribution, hosted services, and enterprise deployment require a commercial license.
