omnius 1.0.159 → 1.0.160
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.
- package/.aiwg/addons/omnius-docs/README.md +5 -0
- package/.aiwg/addons/omnius-docs/manifest.json +32 -0
- package/.aiwg/addons/omnius-docs/skills/omnius-docs/SKILL.md +48 -0
- package/.aiwg/addons/omnius-docs/skills/omnius-ops-docs/SKILL.md +32 -0
- package/.aiwg/addons/omnius-docs/skills/omnius-realtime-docs/SKILL.md +30 -0
- package/.aiwg/addons/omnius-docs/skills/omnius-sponsor-docs/SKILL.md +31 -0
- package/.aiwg/addons/omnius-docs/skills/omnius-telegram-docs/SKILL.md +30 -0
- package/.aiwg/addons/omnius-rest-docs/README.md +7 -0
- package/.aiwg/addons/omnius-rest-docs/manifest.json +24 -0
- package/.aiwg/addons/omnius-rest-docs/skills/omnius-rest-docs/SKILL.md +72 -0
- package/README.md +115 -5011
- package/dist/index.js +561 -74
- package/docs/.vitepress/config.mts +108 -0
- package/docs/agent-memory/INDEX.md +38 -0
- package/docs/agent-memory/index.md +14 -0
- package/docs/architecture/overview.md +30 -0
- package/docs/getting-started/first-run.md +38 -0
- package/docs/getting-started/install.md +58 -0
- package/docs/getting-started/model-providers.md +48 -0
- package/docs/guides/media-generation.md +88 -0
- package/docs/guides/realtime.md +138 -0
- package/docs/guides/sponsor-and-cohere.md +123 -0
- package/docs/guides/telegram.md +95 -0
- package/docs/guides/tui-workflows.md +48 -0
- package/docs/index.md +30 -0
- package/docs/operations/runtime-hygiene.md +75 -0
- package/docs/operations/security-and-remote-access.md +70 -0
- package/docs/reference/configuration.md +45 -0
- package/docs/reference/rest-api.md +225 -0
- package/docs/reference/slash-commands.md +2095 -0
- package/docs/rest/INDEX.md +129 -0
- package/docs/rest/QUICKREF.md +125 -0
- package/docs/rest/REST-DOCS-MANIFEST.json +27 -0
- package/docs/rest/auth-and-scopes.md +101 -0
- package/docs/rest/endpoints/aims.md +26 -0
- package/docs/rest/endpoints/aiwg.md +44 -0
- package/docs/rest/endpoints/chat.md +101 -0
- package/docs/rest/endpoints/config.md +53 -0
- package/docs/rest/endpoints/events.md +63 -0
- package/docs/rest/endpoints/files.md +18 -0
- package/docs/rest/endpoints/memory.md +42 -0
- package/docs/rest/endpoints/run.md +52 -0
- package/docs/rest/endpoints/skills.md +41 -0
- package/docs/rest/endpoints/tools.md +62 -0
- package/docs/rest/endpoints/voice-vision.md +80 -0
- package/docs/rest/errors-pagination-etags.md +84 -0
- package/docs/rest/examples/curl.md +84 -0
- package/docs/rest/examples/openai-sdk.md +59 -0
- package/docs/rest/openapi-source.md +36 -0
- package/npm-shrinkwrap.json +2 -2
- package/package.json +5 -2
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Omnius Docs Addon
|
|
2
|
+
|
|
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
|
+
|
|
5
|
+
Start with `omnius-docs`, then load a more specific skill when the task is about realtime, sponsors, Telegram, or operations.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "omnius-docs",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Project-local Omnius documentation bundle for discover-then-expand agent workflows.",
|
|
5
|
+
"skills": [
|
|
6
|
+
{
|
|
7
|
+
"name": "omnius-docs",
|
|
8
|
+
"description": "Find the right Omnius documentation page for setup, TUI, endpoints, realtime, sponsor, COHERE, Telegram, media, operations, architecture, and REST references.",
|
|
9
|
+
"triggers": ["Omnius docs", "Omnius documentation", "how to use Omnius", "Omnius guide", "Omnius manual"]
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
"name": "omnius-realtime-docs",
|
|
13
|
+
"description": "Use Omnius realtime spoken conversation mode through /realtime or REST realtime=true.",
|
|
14
|
+
"triggers": ["Omnius realtime", "/realtime", "realtime REST", "ASR TTS chat", "voice conversation mode"]
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
"name": "omnius-sponsor-docs",
|
|
18
|
+
"description": "Configure and consume sponsor inference, COHERE distributed inference, endpoint passthrough, media sponsorship, and peer telemetry.",
|
|
19
|
+
"triggers": ["Omnius sponsor", "/sponsor", "/cohere", "sponsor endpoint", "COHERE mesh", "media sponsorship"]
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "omnius-telegram-docs",
|
|
23
|
+
"description": "Configure Telegram bridge behavior, scoped persona state, reply preferences, media intake, and raw failure feedback.",
|
|
24
|
+
"triggers": ["Omnius Telegram", "/telegram", "Telegram persona", "Telegram reply preferences", "Telegram failure feedback"]
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "omnius-ops-docs",
|
|
28
|
+
"description": "Operate Omnius safely: .omnius hygiene, Ollama cleanup, broker, remote access, API keys, elevation prompts, and runtime failure capture.",
|
|
29
|
+
"triggers": ["Omnius operations", "Ollama cleanup", "/broker", "remote access", "API keys", ".omnius"]
|
|
30
|
+
}
|
|
31
|
+
]
|
|
32
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
compaction_strategy: structured
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# omnius-docs
|
|
6
|
+
|
|
7
|
+
Find and use Omnius documentation without loading the whole docs tree.
|
|
8
|
+
|
|
9
|
+
## Triggers
|
|
10
|
+
|
|
11
|
+
- Omnius docs
|
|
12
|
+
- Omnius documentation
|
|
13
|
+
- how to use Omnius
|
|
14
|
+
- Omnius guide
|
|
15
|
+
- Omnius manual
|
|
16
|
+
- Omnius setup
|
|
17
|
+
- Omnius architecture
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
1. Start with `README.md` only for product overview and top-level docs map.
|
|
22
|
+
2. For setup questions, open `docs/getting-started/`.
|
|
23
|
+
3. For user workflows, open the relevant file under `docs/guides/`.
|
|
24
|
+
4. For commands, config, and API inventory, open `docs/reference/`.
|
|
25
|
+
5. For runtime and deployment questions, open `docs/operations/`.
|
|
26
|
+
6. For implementation shape, open `docs/architecture/overview.md`.
|
|
27
|
+
7. Read only the smallest relevant page before answering.
|
|
28
|
+
|
|
29
|
+
## Map
|
|
30
|
+
|
|
31
|
+
- Install: `docs/getting-started/install.md`
|
|
32
|
+
- First run: `docs/getting-started/first-run.md`
|
|
33
|
+
- Model providers: `docs/getting-started/model-providers.md`
|
|
34
|
+
- Realtime: `docs/guides/realtime.md`
|
|
35
|
+
- Sponsor and COHERE: `docs/guides/sponsor-and-cohere.md`
|
|
36
|
+
- Telegram: `docs/guides/telegram.md`
|
|
37
|
+
- Media generation: `docs/guides/media-generation.md`
|
|
38
|
+
- TUI workflows: `docs/guides/tui-workflows.md`
|
|
39
|
+
- REST API: `docs/reference/rest-api.md`
|
|
40
|
+
- Slash commands: `docs/reference/slash-commands.md`
|
|
41
|
+
- Configuration: `docs/reference/configuration.md`
|
|
42
|
+
- Runtime hygiene: `docs/operations/runtime-hygiene.md`
|
|
43
|
+
- Security and remote access: `docs/operations/security-and-remote-access.md`
|
|
44
|
+
- Architecture: `docs/architecture/overview.md`
|
|
45
|
+
|
|
46
|
+
## Canonical Sources
|
|
47
|
+
|
|
48
|
+
When documentation and code disagree, verify against the code or live daemon. REST machine contract lives in `packages/cli/src/api/openapi.ts`.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
compaction_strategy: structured
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# omnius-ops-docs
|
|
6
|
+
|
|
7
|
+
Use Omnius operations docs for runtime hygiene, remote access, API keys, installer elevation, broker state, and Ollama cleanup.
|
|
8
|
+
|
|
9
|
+
## Triggers
|
|
10
|
+
|
|
11
|
+
- Omnius operations
|
|
12
|
+
- Ollama cleanup
|
|
13
|
+
- /broker
|
|
14
|
+
- remote access
|
|
15
|
+
- API keys
|
|
16
|
+
- .omnius
|
|
17
|
+
- installer elevation
|
|
18
|
+
- runtime hygiene
|
|
19
|
+
|
|
20
|
+
## Workflow
|
|
21
|
+
|
|
22
|
+
1. Read `docs/operations/runtime-hygiene.md`.
|
|
23
|
+
2. For auth or binding, read `docs/operations/security-and-remote-access.md`.
|
|
24
|
+
3. For configuration details, read `docs/reference/configuration.md`.
|
|
25
|
+
4. For endpoint inventory, read `docs/reference/rest-api.md`.
|
|
26
|
+
|
|
27
|
+
## Key Facts
|
|
28
|
+
|
|
29
|
+
- `.omnius/` is runtime state and should be gitignored.
|
|
30
|
+
- Ollama cleanup must account for orphan runner processes.
|
|
31
|
+
- Elevation prompts should suspend and restore TUI state.
|
|
32
|
+
- Raw failures should be captured and fed back as observations.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
compaction_strategy: structured
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# omnius-realtime-docs
|
|
6
|
+
|
|
7
|
+
Use Omnius realtime mode for short spoken ASR/TTS-backed conversation.
|
|
8
|
+
|
|
9
|
+
## Triggers
|
|
10
|
+
|
|
11
|
+
- Omnius realtime
|
|
12
|
+
- /realtime
|
|
13
|
+
- realtime REST
|
|
14
|
+
- ASR TTS chat
|
|
15
|
+
- voice conversation mode
|
|
16
|
+
- realtime true
|
|
17
|
+
|
|
18
|
+
## Workflow
|
|
19
|
+
|
|
20
|
+
1. Read `docs/guides/realtime.md`.
|
|
21
|
+
2. If the user asks for REST fields, also read `docs/rest/endpoints/chat.md`.
|
|
22
|
+
3. If the user asks for voice transport, also read `docs/rest/endpoints/voice-vision.md`.
|
|
23
|
+
4. Mention that realtime is for short spoken dialogue, not long coding tasks.
|
|
24
|
+
|
|
25
|
+
## Key Facts
|
|
26
|
+
|
|
27
|
+
- TUI command: `/realtime on|off|status`.
|
|
28
|
+
- REST flag: `realtime: true`.
|
|
29
|
+
- Options: `realtime_options.max_history_messages`, `realtime_options.max_tokens`.
|
|
30
|
+
- Context sources: `SOUL.md`, `.aiwg/SOUL.md`, and `.aiwg/voices/`.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
compaction_strategy: structured
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# omnius-sponsor-docs
|
|
6
|
+
|
|
7
|
+
Use Omnius sponsor and COHERE documentation for peer inference, endpoint passthrough, media sponsorship, and telemetry.
|
|
8
|
+
|
|
9
|
+
## Triggers
|
|
10
|
+
|
|
11
|
+
- Omnius sponsor
|
|
12
|
+
- /sponsor
|
|
13
|
+
- /endpoint sponsor
|
|
14
|
+
- /cohere
|
|
15
|
+
- COHERE mesh
|
|
16
|
+
- sponsor endpoint
|
|
17
|
+
- media sponsorship
|
|
18
|
+
- peer telemetry
|
|
19
|
+
|
|
20
|
+
## Workflow
|
|
21
|
+
|
|
22
|
+
1. Read `docs/guides/sponsor-and-cohere.md`.
|
|
23
|
+
2. For endpoint setup, read `docs/getting-started/model-providers.md`.
|
|
24
|
+
3. For remote access and auth concerns, read `docs/operations/security-and-remote-access.md`.
|
|
25
|
+
4. For REST sponsor directory details, read `docs/reference/rest-api.md`.
|
|
26
|
+
|
|
27
|
+
## Key Facts
|
|
28
|
+
|
|
29
|
+
- Sponsor model discovery must consolidate all toggled enabled endpoints.
|
|
30
|
+
- Consumers should not see raw upstream sponsor URLs or secrets.
|
|
31
|
+
- Sponsor telemetry should include concurrency, request rate, daily tokens, peer usage, model usage, and media usage.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
compaction_strategy: structured
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# omnius-telegram-docs
|
|
6
|
+
|
|
7
|
+
Use Omnius Telegram docs for bridge setup, scoped persona state, public tools, reply preferences, and delivery failures.
|
|
8
|
+
|
|
9
|
+
## Triggers
|
|
10
|
+
|
|
11
|
+
- Omnius Telegram
|
|
12
|
+
- /telegram
|
|
13
|
+
- Telegram bridge
|
|
14
|
+
- Telegram persona
|
|
15
|
+
- Telegram reply preferences
|
|
16
|
+
- Telegram failure feedback
|
|
17
|
+
- public Telegram tools
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
1. Read `docs/guides/telegram.md`.
|
|
22
|
+
2. For media generation from Telegram, read `docs/guides/media-generation.md`.
|
|
23
|
+
3. For public-surface safety, read `docs/operations/security-and-remote-access.md`.
|
|
24
|
+
4. Preserve user, chat, reply, and media scope when answering implementation questions.
|
|
25
|
+
|
|
26
|
+
## Key Facts
|
|
27
|
+
|
|
28
|
+
- Telegram state is scoped by user and group.
|
|
29
|
+
- Reply preferences are durable persona state, not regex routing.
|
|
30
|
+
- Raw platform/tool failures should be fed back as observations, not hardcoded string rules.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Omnius REST Docs Addon
|
|
2
|
+
|
|
3
|
+
This project-local AIWG-shaped addon exposes the Omnius REST API reference through the existing Omnius skill-discovery path.
|
|
4
|
+
|
|
5
|
+
Agents should discover it with `skill_list filter="rest"` or `/skills rest`, then load `omnius-rest-docs` only when the current task needs REST API guidance.
|
|
6
|
+
|
|
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`.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "omnius-rest-docs",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Project-local Omnius REST API documentation bundle for discover-then-expand agent workflows.",
|
|
5
|
+
"skills": [
|
|
6
|
+
{
|
|
7
|
+
"name": "omnius-rest-docs",
|
|
8
|
+
"description": "Explore Omnius REST API docs, OpenAPI source, auth scopes, realtime chat, tools, memory, AIWG, voice, sponsor, and governance endpoints.",
|
|
9
|
+
"triggers": [
|
|
10
|
+
"Omnius REST API",
|
|
11
|
+
"/v1 endpoints",
|
|
12
|
+
"OpenAPI",
|
|
13
|
+
"Swagger UI",
|
|
14
|
+
"/openapi.json",
|
|
15
|
+
"API key scopes",
|
|
16
|
+
"realtime REST",
|
|
17
|
+
"memory REST endpoint",
|
|
18
|
+
"skills REST endpoint",
|
|
19
|
+
"AIWG cascade endpoint",
|
|
20
|
+
"voicechat websocket"
|
|
21
|
+
]
|
|
22
|
+
}
|
|
23
|
+
]
|
|
24
|
+
}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
compaction_strategy: structured
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# omnius-rest-docs
|
|
6
|
+
|
|
7
|
+
Explore Omnius REST API documentation without loading the whole API reference into the main context.
|
|
8
|
+
|
|
9
|
+
## Triggers
|
|
10
|
+
|
|
11
|
+
- Omnius REST API
|
|
12
|
+
- /v1 endpoints
|
|
13
|
+
- OpenAPI
|
|
14
|
+
- Swagger UI
|
|
15
|
+
- /openapi.json
|
|
16
|
+
- API key scopes
|
|
17
|
+
- realtime REST
|
|
18
|
+
- /v1/chat
|
|
19
|
+
- /v1/chat/completions
|
|
20
|
+
- /v1/run
|
|
21
|
+
- memory REST endpoint
|
|
22
|
+
- skills REST endpoint
|
|
23
|
+
- AIWG cascade endpoint
|
|
24
|
+
- voicechat websocket
|
|
25
|
+
- sponsor REST status
|
|
26
|
+
- Omnius daemon API
|
|
27
|
+
|
|
28
|
+
## Workflow
|
|
29
|
+
|
|
30
|
+
1. Start with `docs/rest/INDEX.md`.
|
|
31
|
+
2. Identify the endpoint family that matches the user's question.
|
|
32
|
+
3. Open `docs/reference/rest-api.md` when the user needs endpoint inventory or method/path details.
|
|
33
|
+
4. Open only the relevant file under `docs/rest/endpoints/` or `docs/rest/examples/` for family-specific usage.
|
|
34
|
+
5. Treat `packages/cli/src/api/openapi.ts` and the live daemon `/openapi.json` as the canonical machine contract.
|
|
35
|
+
6. Prefer concise endpoint-specific guidance over copying long tables.
|
|
36
|
+
|
|
37
|
+
## Endpoint Family Map
|
|
38
|
+
|
|
39
|
+
- Chat, realtime, OpenAI-compatible inference: `docs/rest/endpoints/chat.md`
|
|
40
|
+
- Full endpoint inventory: `docs/reference/rest-api.md`
|
|
41
|
+
- Agent runs, jobs, todos, scheduled tasks: `docs/rest/endpoints/run.md`
|
|
42
|
+
- Config, keys, profiles, projects: `docs/rest/endpoints/config.md`
|
|
43
|
+
- Memory, sessions, context: `docs/rest/endpoints/memory.md`
|
|
44
|
+
- Skills and commands: `docs/rest/endpoints/skills.md`
|
|
45
|
+
- AIWG cascade: `docs/rest/endpoints/aiwg.md`
|
|
46
|
+
- Tools, MCP, code graph: `docs/rest/endpoints/tools.md`
|
|
47
|
+
- Events, metrics, usage, audit, system: `docs/rest/endpoints/events.md`
|
|
48
|
+
- Files: `docs/rest/endpoints/files.md`
|
|
49
|
+
- Voice, audio, vision, voicechat WebSocket: `docs/rest/endpoints/voice-vision.md`
|
|
50
|
+
- AIMS governance endpoints: `docs/rest/endpoints/aims.md`
|
|
51
|
+
- Curl examples: `docs/rest/examples/curl.md`
|
|
52
|
+
- OpenAI SDK examples: `docs/rest/examples/openai-sdk.md`
|
|
53
|
+
|
|
54
|
+
## Realtime Shortcut
|
|
55
|
+
|
|
56
|
+
For ASR/TTS-backed short conversation, use `POST /v1/chat` or `POST /v1/chat/completions` with:
|
|
57
|
+
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"realtime": true,
|
|
61
|
+
"realtime_options": {
|
|
62
|
+
"max_history_messages": 12,
|
|
63
|
+
"max_tokens": 160
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Realtime mode compacts SOUL.md and voice profile context, keeps recent history short, and removes Omnius-only control fields before backend proxying.
|
|
69
|
+
|
|
70
|
+
## Safety And Authority
|
|
71
|
+
|
|
72
|
+
This skill is documentation guidance only. It does not override user instructions, system instructions, developer policy, API auth scopes, tool security policy, network access settings, or live OpenAPI behavior.
|