omnius 1.0.607 → 1.0.609

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,13 +2,15 @@
2
2
 
3
3
  This project-local addon exposes Omnius documentation as small discoverable skills. It is for agents that need to answer questions about Omnius without loading the entire docs tree.
4
4
 
5
- Start with `omnius-docs`, then load a more specific skill when the task is
5
+ Start with `omnius-agent-onboarding` when the agent has no Omnius context, or
6
+ `omnius-docs` when it already knows the documentation domain. Then load a more specific skill when the task is
6
7
  about inference providers, tools/web search, service integration, version
7
8
  compatibility, realtime, sponsors, Telegram, operations, or browser
8
9
  interaction validation.
9
10
 
10
11
  Documentation-routing skills:
11
12
 
13
+ - `omnius-agent-onboarding`
12
14
  - `omnius-inference-docs`
13
15
  - `omnius-tools-docs`
14
16
  - `omnius-integration-docs`
@@ -2,8 +2,8 @@
2
2
  "id": "omnius-docs",
3
3
  "type": "addon",
4
4
  "name": "Omnius Documentation",
5
- "version": "1.1.0",
6
- "description": "Project-local Omnius documentation bundle for discover-then-expand agent workflows.",
5
+ "version": "1.2.0",
6
+ "description": "Project-local Omnius agent onboarding, system map, and discover-then-expand documentation bundle.",
7
7
  "manifestVersion": "1",
8
8
  "platforms": {
9
9
  "claude": "full",
@@ -16,6 +16,8 @@
16
16
  "omnius",
17
17
  "documentation",
18
18
  "discovery",
19
+ "agent-onboarding",
20
+ "system-map",
19
21
  "inference",
20
22
  "tools",
21
23
  "operations",
@@ -0,0 +1,70 @@
1
+ ---
2
+ name: omnius-agent-onboarding
3
+ description: Bootstrap any agent into Omnius, choose the correct entrypoint, locate layer/module/state ownership, and verify live behavior without guessing.
4
+ compaction_strategy: structured
5
+ ---
6
+
7
+ # omnius-agent-onboarding
8
+
9
+ Use this skill when an agent is new to Omnius or unsure which command, REST
10
+ route, tool, runtime, state root, or source module owns a requested outcome.
11
+
12
+ ## Triggers
13
+
14
+ - how do I use Omnius
15
+ - integrate an agent with Omnius
16
+ - where is this implemented
17
+ - which Omnius endpoint or command
18
+ - Omnius architecture, runtime, state, or ownership
19
+ - debug Omnius without prior context
20
+
21
+ ## Minimal Bootstrap
22
+
23
+ 1. Run `omnius docs` or read `GET /v1/discovery/bootstrap`.
24
+ 2. Search the desired outcome with `omnius discover "<intent>"`.
25
+ 3. Expand one stable ID with `omnius show <id>`.
26
+ 4. Read `use_when`, `avoid_when`, interfaces, workflow, safety, state,
27
+ verification, failure recovery, and source-of-truth.
28
+ 5. For live work, compare `GET /version`, then inspect `/openapi.json` and the
29
+ relevant live registry before executing.
30
+ 6. Verify the requested terminal result; accepted/queued is not completion.
31
+
32
+ ## Route By Agent Size
33
+
34
+ - Small-context agent: bootstrap + one `workflow.*` entry + one referenced page.
35
+ - Coding agent: also expand the owning `layer.*` and `module.*` entries.
36
+ - Service integrator: also expand the exact `api.*`, tool, or provider entry
37
+ and validate the running OpenAPI/live registry.
38
+ - Operator: expand `layer.operations`, the affected `runtime.*`, and
39
+ `workflow.debug-runtime`.
40
+ - Maintainer: read `docs/architecture/agent-system-map.md`, then inspect the
41
+ canonical registry and targeted tests before editing.
42
+
43
+ ## Entrypoint Rules
44
+
45
+ - `omnius`: interactive TUI and human-only slash commands.
46
+ - `omnius "<task>"`: one foreground shell task.
47
+ - `POST /v1/chat`: stateful daemon conversation.
48
+ - `POST /v1/chat/completions`: OpenAI-compatible request, optionally an agent loop.
49
+ - `POST /v1/run`: long asynchronous task with an ID, events, and cancellation.
50
+ - `POST /v1/tools/{name}/call`: only when metadata declares direct-call exposure.
51
+
52
+ Never infer a REST command from a slash command or a direct route from a tool
53
+ name. Expand `workflow.choose-entrypoint` when uncertain.
54
+
55
+ ## State Rules
56
+
57
+ - `<project>/.omnius`: project conversations, tasks/runs, context, indexes,
58
+ memories, and project preferences.
59
+ - `~/.omnius`: daemon/update identity, global config and credentials, managed
60
+ runtimes, shared model/media storage, and workspace registry.
61
+
62
+ Resolve the active workspace before touching project state. Do not emit secrets.
63
+
64
+ ## Canonical References
65
+
66
+ - Generated bootstrap/catalog: `docs/DISCOVERY.md`, `docs/DISCOVERY.json`
67
+ - System ownership: `docs/architecture/agent-system-map.md`
68
+ - Service integration: `docs/guides/agent-integration.md`
69
+ - Live REST contract: `GET /openapi.json`
70
+ - Source discovery contract: `docs/discovery/agent-map.json`
@@ -21,13 +21,16 @@ Find and use Omnius documentation without loading the whole docs tree.
21
21
  ## Workflow
22
22
 
23
23
  1. Start with `README.md` only for product overview and top-level docs map.
24
- 2. Search `docs/DISCOVERY.json` by stable ID, alias, or intent.
24
+ 2. If the caller is new to Omnius, use the `omnius-agent-onboarding` skill and
25
+ read the bootstrap in `docs/DISCOVERY.md`.
26
+ 3. Search `docs/DISCOVERY.json` by stable ID, alias, or intent.
25
27
  3. For setup questions, open `docs/getting-started/`.
26
28
  4. For user workflows, open the relevant file under `docs/guides/`.
27
29
  5. For commands, config, and API inventory, open `docs/reference/`.
28
30
  6. For runtime and deployment questions, open `docs/operations/`.
29
- 7. For implementation shape, open `docs/architecture/overview.md`.
30
- 8. Read only the smallest relevant page before answering.
31
+ 8. For implementation shape and ownership, open
32
+ `docs/architecture/agent-system-map.md` before the shorter overview.
33
+ 9. Read only the smallest relevant page before answering.
31
34
 
32
35
  ## Map
33
36
 
@@ -38,6 +41,7 @@ Find and use Omnius documentation without loading the whole docs tree.
38
41
  - Bring your own inference: `docs/guides/bring-your-own-inference.md`
39
42
  - Tools and web search: `docs/guides/tools-and-web-search.md`
40
43
  - Agent integration: `docs/guides/agent-integration.md`
44
+ - Agent system map: `docs/architecture/agent-system-map.md`
41
45
  - Service compatibility: `docs/operations/version-compatibility.md`
42
46
  - Realtime: `docs/guides/realtime.md`
43
47
  - Sponsor and COHERE: `docs/guides/sponsor-and-cohere.md`
@@ -49,7 +53,7 @@ Find and use Omnius documentation without loading the whole docs tree.
49
53
  - Configuration: `docs/reference/configuration.md`
50
54
  - Runtime hygiene: `docs/operations/runtime-hygiene.md`
51
55
  - Security and remote access: `docs/operations/security-and-remote-access.md`
52
- - Architecture: `docs/architecture/overview.md`
56
+ - Architecture: `docs/architecture/agent-system-map.md`
53
57
 
54
58
  ## Canonical Sources
55
59
 
@@ -6,5 +6,6 @@ Agents should discover it with `skill_list filter="rest"` or `/skills rest`, the
6
6
 
7
7
  The human-readable docs live in `docs/rest/`. The machine-readable contract is generated by `packages/cli/src/api/openapi.ts` and served by the daemon at `/openapi.json`.
8
8
 
9
- For intent-first lookup, use `omnius discover`, `GET /v1/discovery`, or the
9
+ For a new agent, start with `GET /v1/discovery/bootstrap`. For intent-first
10
+ lookup, use `omnius discover`, `GET /v1/discovery`, or the
10
11
  bundled `docs/DISCOVERY.json` before opening a REST family page.
@@ -29,13 +29,15 @@ Explore Omnius REST API documentation without loading the whole API reference in
29
29
 
30
30
  ## Workflow
31
31
 
32
- 1. Start with `docs/rest/INDEX.md`.
33
- 2. For intent lookup, search `docs/DISCOVERY.json` or `GET /v1/discovery`.
32
+ 1. If the caller does not know which Omnius surface it needs, read
33
+ `GET /v1/discovery/bootstrap` and expand `workflow.choose-entrypoint`.
34
+ 2. Start with `docs/rest/INDEX.md`.
35
+ 3. For intent lookup, search `docs/DISCOVERY.json` or `GET /v1/discovery`.
34
36
  3. Identify the endpoint family that matches the user's question.
35
37
  4. Open `docs/reference/rest-api.md` when the user needs endpoint inventory or method/path details.
36
38
  5. Open only the relevant file under `docs/rest/endpoints/` or `docs/rest/examples/` for family-specific usage.
37
39
  6. Treat `packages/cli/src/api/openapi.ts` and the live daemon `/openapi.json` as the canonical machine contract.
38
- 7. Prefer concise endpoint-specific guidance over copying long tables.
40
+ 8. Prefer concise endpoint-specific guidance over copying long tables.
39
41
 
40
42
  ## Endpoint Family Map
41
43
 
package/README.md CHANGED
@@ -49,6 +49,9 @@ which endpoint owns a capability:
49
49
 
50
50
  ```bash
51
51
  omnius discover "bring your own inference"
52
+ omnius show workflow.choose-entrypoint
53
+ omnius show layer.orchestration
54
+ omnius show store.project
52
55
  omnius show provider.anthropic
53
56
  omnius show provider.gemini
54
57
  omnius show tool.web-search
@@ -57,14 +60,15 @@ omnius show capability.osint-research
57
60
  omnius capabilities --json
58
61
  ```
59
62
 
60
- With the daemon running, the same discovery cascade is available at
61
- `GET /v1/discovery`, with exact entry expansion at
63
+ With the daemon running, begin at `GET /v1/discovery/bootstrap`. The same
64
+ discovery cascade is available at `GET /v1/discovery`, with exact entry expansion at
62
65
  `GET /v1/discovery/{id}`. The live API contract remains available at
63
66
  `/openapi.json`, direct tool metadata at `/v1/tools`, and skills at
64
67
  `/v1/skills`.
65
68
 
66
69
  Start with [the discovery guide](docs/DISCOVERY.md) when integrating another
67
- agent or service. Use [bring-your-own inference](docs/guides/bring-your-own-inference.md)
70
+ agent or service, and use the [agent system map](docs/architecture/agent-system-map.md)
71
+ to trace layers, modules, runtimes, and state ownership. Use [bring-your-own inference](docs/guides/bring-your-own-inference.md)
68
72
  for provider protocols and keys, and [tools and web search](docs/guides/tools-and-web-search.md)
69
73
  for the distinction between direct tools and agent-bound tools. The
70
74
  [categorized OSINT research guide](docs/guides/osint-research.md) documents
@@ -222,6 +226,7 @@ The complete endpoint inventory follows. It is kept in lockstep with the served
222
226
 
223
227
  | Method | Path | Purpose |
224
228
  | --- | --- | --- |
229
+ | `GET` | `/v1/discovery/bootstrap` | Compact agent bootstrap and start-here map |
225
230
  | `GET` | `/v1/discovery` | Search or list the bundled capability catalog |
226
231
  | `GET` | `/v1/discovery/{id}` | Expand one stable capability entry |
227
232
 
@@ -369,9 +374,11 @@ Context-window dumps are written for main agents, sub-agents, internal runners,
369
374
  | `POST` | `/v1/voice/start` · `/v1/voice/stop` | Enable/warm voice · pause voice input |
370
375
  | `GET`/`POST` | `/v1/voice/models` · `/v1/voice/models/switch` | List · switch and enable an exact TTS model |
371
376
  | `GET`/`POST` | `/v1/voice/supertonic-settings` | Read · update voice tuning |
372
- | `GET`/`POST` | `/v1/voice/asr-models` · `/v1/voice/asr-models/switch` | List · switch ASR model |
377
+ | `GET`/`PATCH` | `/v1/asr/engines` · `/v1/asr/selection` | List readiness/capabilities · select exact ASR engine/model |
378
+ | `POST` | `/v1/asr/activate` · `/v1/asr/engines/{engineId}/setup` | Activate · install pinned ASR runtime/weights |
379
+ | `POST` | `/v1/asr/transcriptions` · `/v1/asr/test` | Transcribe · test the selected ASR backend |
373
380
  | `POST` | `/v1/voice/tts` · `/v1/audio/speech` | Synthesize speech (+ OpenAI alias) |
374
- | `POST` | `/v1/voice/transcribe` · `/v1/audio/transcriptions` · `/v1/voice/transcribe/stream` | Transcribe (+ alias + streaming) |
381
+ | `POST` | `/v1/voice/transcribe` · `/v1/audio/transcriptions` · `/v1/voice/transcribe/stream` | Transcribe (+ alias + isolated final SSE) |
375
382
  | `GET`/`POST` | `/v1/voice/clone-refs` | List · upload clone reference |
376
383
  | `POST` | `/v1/voice/clone-refs/upload` · `/v1/voice/clone-refs/from-url` | Upload · fetch clone reference |
377
384
  | `POST` | `/v1/voice/clone-refs/{filename}/activate` · `/v1/voice/clone-refs/{filename}/rename` | Activate · rename clone reference |
@@ -386,6 +393,15 @@ voice. The built-in registry includes GLaDOS, Overwatch, and the packaged
386
393
  sub-model set; use `OMNIUS_VOICEBOX_MODELS=all` for the full suite or a
387
394
  comma-separated list of `voicebox_*` IDs for an explicit subset.
388
395
 
396
+ ASR is a separate multi-engine registry: Whisper, managed transcribe-cli,
397
+ Nemotron readiness, and pinned `microsoft/VibeVoice-ASR`. VibeVoice is a
398
+ file/final backend (not incremental PCM) with up to 60-minute transcription,
399
+ speaker diarization, timestamps, and optional context/hotwords. Its ~17.35 GB
400
+ weights are installed into the unified ASR cache on demand and never bundled
401
+ in npm; activation is CUDA-only and fails closed unless the exact GPU is
402
+ verified through `nvidia-smi` (discrete Linux) or `tegrastats` plus CUDA Torch
403
+ device properties (Jetson/L4T).
404
+
389
405
  ### Generative media
390
406
 
391
407
  Backed by the unified `~/.omnius` store and shared venvs (see [Shared Media Dependencies](#shared-media-dependencies)). Outputs land in the global gallery at `~/.omnius/media/{images,videos,audio,music}`.
@@ -1,4 +1,5 @@
1
- export type DiscoveryKind = "capability" | "provider" | "tool" | "api" | "command" | "skill" | "guide" | "config" | "operation";
1
+ export type DiscoveryKind = "capability" | "layer" | "module" | "workflow" | "runtime" | "store" | "provider" | "tool" | "api" | "command" | "skill" | "guide" | "config" | "operation";
2
+ export declare const DISCOVERY_KINDS: readonly ["capability", "layer", "module", "workflow", "runtime", "store", "provider", "tool", "api", "command", "skill", "guide", "config", "operation"];
2
3
  export interface DiscoveryInterface {
3
4
  type: string;
4
5
  target: string;
@@ -9,6 +10,40 @@ export interface DiscoveryReference {
9
10
  target: string;
10
11
  relation?: string;
11
12
  }
13
+ export interface DiscoveryStep {
14
+ step: string;
15
+ action: string;
16
+ interface?: string;
17
+ expected?: string;
18
+ on_failure?: string;
19
+ }
20
+ export interface DiscoveryExample {
21
+ title?: string;
22
+ command?: string;
23
+ request?: Record<string, unknown>;
24
+ notes?: string;
25
+ }
26
+ export interface DiscoveryFailureMode {
27
+ symptom: string;
28
+ likely_cause: string;
29
+ recovery: string;
30
+ }
31
+ export interface DiscoveryVerification {
32
+ check: string;
33
+ expected: string;
34
+ }
35
+ export interface DiscoveryBootstrap {
36
+ strategy: string[];
37
+ start_here: string[];
38
+ agent_profiles?: Record<string, string[]>;
39
+ common_intents?: Array<{
40
+ intent: string;
41
+ query: string;
42
+ expand?: string;
43
+ }>;
44
+ live_checks?: string[];
45
+ safety_rules?: string[];
46
+ }
12
47
  export interface DiscoveryEntry {
13
48
  id: string;
14
49
  kind: DiscoveryKind;
@@ -17,16 +52,30 @@ export interface DiscoveryEntry {
17
52
  aliases?: string[];
18
53
  keywords?: string[];
19
54
  maturity?: string;
55
+ layer?: string;
56
+ audiences?: string[];
57
+ use_when?: string[];
58
+ avoid_when?: string[];
59
+ inputs?: string[];
60
+ outputs?: string[];
61
+ source_of_truth?: string[];
20
62
  prerequisites?: string[];
21
63
  interfaces?: DiscoveryInterface[];
22
64
  references?: DiscoveryReference[];
23
65
  related?: string[];
66
+ workflow?: DiscoveryStep[];
67
+ examples?: DiscoveryExample[];
68
+ verification?: DiscoveryVerification[];
69
+ failure_modes?: DiscoveryFailureMode[];
70
+ state?: Record<string, unknown>;
71
+ safety?: Record<string, unknown>;
24
72
  [key: string]: unknown;
25
73
  }
26
74
  export interface DiscoveryCatalog {
27
75
  schema_version: string;
28
76
  generated_at?: string;
29
77
  package_version?: string;
78
+ bootstrap?: DiscoveryBootstrap;
30
79
  entries: DiscoveryEntry[];
31
80
  [key: string]: unknown;
32
81
  }
@@ -34,6 +83,9 @@ export interface DiscoveryQueryOptions {
34
83
  kind?: DiscoveryKind;
35
84
  limit?: number;
36
85
  offset?: number;
86
+ audience?: string;
87
+ layer?: string;
88
+ includeInternal?: boolean;
37
89
  }
38
90
  export interface DiscoveryResult {
39
91
  score: number;
@@ -42,9 +94,10 @@ export interface DiscoveryResult {
42
94
  export declare function findDiscoveryCatalogPath(): string | null;
43
95
  export declare function loadDiscoveryCatalog(): DiscoveryCatalog;
44
96
  export declare function discoverCapabilities(query?: string, options?: DiscoveryQueryOptions, catalog?: DiscoveryCatalog): DiscoveryResult[];
45
- export declare function rankCapabilities(query?: string, kind?: DiscoveryKind, catalog?: DiscoveryCatalog): DiscoveryResult[];
97
+ export declare function rankCapabilities(query?: string, kind?: DiscoveryKind, catalog?: DiscoveryCatalog, options?: Pick<DiscoveryQueryOptions, "audience" | "layer" | "includeInternal">): DiscoveryResult[];
46
98
  export declare function showCapability(id: string, catalog?: DiscoveryCatalog): DiscoveryEntry | undefined;
47
99
  export declare function renderDiscoveryEntry(entry: DiscoveryEntry): string;
100
+ export declare function discoveryBootstrap(catalog?: DiscoveryCatalog): DiscoveryBootstrap;
48
101
  export declare function discoverySchemaVersion(): string;
49
102
  export declare function discoveryDocsRoot(): string | null;
50
103
  //# sourceMappingURL=discovery.d.ts.map