# Install Omnius

This guide gets a machine ready to run Omnius from npm or from the workspace.

## Requirements

- Node.js 22 or newer
- npm 10 or newer for published CLI use
- pnpm 9 or newer for workspace development
- A local model endpoint, remote OpenAI-compatible endpoint, or sponsor/peer endpoint

## Install From npm

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

The first launch opens the setup flow, probes local capabilities, and asks which endpoint and model path to use.

The installer prints a short agent-discovery primer. It does not print keys or
other secrets. You can run the discovery commands at any time:

```bash
omnius discover "bring your own inference"
omnius show tool.web-search
omnius docs
omnius init
```

`omnius init` adds a managed Omnius discovery block to the project guidance
files without replacing content outside that block. `--check` reports whether
the guidance is current and `--dry-run` previews changes.

## Start The REST Daemon

```bash
omnius serve
```

Default daemon URL:

```text
http://127.0.0.1:11435
```

Open API docs:

```text
http://127.0.0.1:11435/docs
```

Agent-readable daemon entrypoints:

```text
http://127.0.0.1:11435/help
http://127.0.0.1:11435/openapi.json
http://127.0.0.1:11435/v1/discovery/bootstrap
http://127.0.0.1:11435/v1/tools
http://127.0.0.1:11435/v1/skills
```

## Workspace Development

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

Useful focused checks:

```bash
pnpm --filter omnius exec vitest run tests/realtime-mode.test.ts tests/command-registry.test.ts
pnpm --filter @omnius/execution exec vitest run tests/skill-discovery.test.ts
```

## Runtime State

Omnius stores project runtime state under `.omnius/`. This directory includes settings, jobs, context, sponsor state, scoped Telegram persona state, and generated connector artifacts.

Do not commit `.omnius/`. Omnius adds it to `.gitignore` automatically for repositories that have or later create a `.gitignore`.