You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Desktop builds: macOS (`arm64`, `x64`), Windows (`x64`), Linux (`x64` AppImage).
16
+
- Release builds are unsigned. macOS and Windows may require manual confirmation on first launch.
17
+
- The app is usable day to day, but still moving quickly. Expect active iteration around Agents, tool calling, and provider compatibility.
18
+
12
19
## User Documentation
13
20
14
21
- Detailed user guide: [`docs/vellium/README.md`](./docs/vellium/README.md)
@@ -17,9 +24,9 @@ Desktop app built with Electron, React, a local Express API, and SQLite.
17
24
## Important
18
25
- Use `npm run dev` for day-to-day development.
19
26
- Use `npm run dev:electron` when testing the real desktop shell.
20
-
- Use `npm run dist:mac` / `npm run dist:win`for desktop bundles.
21
-
- CI desktop builds are unsigned. macOS and Windows may require manual confirmation.
22
-
-Desktop packaging works, but it still has rough edges. It is usable, not polished.
27
+
- Use `npm run dist:mac`, `npm run dist:win`, or `npm run dist:linux`for platform bundles.
28
+
- CI publishes GitHub Release assets when a `v*` tag is pushed.
29
+
-Local data is stored in `data/` during development and in the Electron user-data directory in packaged builds.
23
30
24
31
## Stack
25
32
- Electron
@@ -30,14 +37,23 @@ Desktop app built with Electron, React, a local Express API, and SQLite.
30
37
31
38
## Core Features
32
39
40
+
### Agents
41
+
- Dedicated `Agents` workspace with ask, build, and research modes.
42
+
- Workspace tools for listing, reading, searching, editing, moving, deleting, and diffing files.
43
+
- Optional command execution for tests/builds, with separate security gates for shell-like commands, network commands, destructive file operations, and git writes.
44
+
- OpenAI-compatible structured planning with JSON-schema responses when supported.
- Context management for long agent threads, including auto-compaction, continuation cues, duplicate read-only call guards, and stale-run cleanup after edits/deletes.
47
+
33
48
### Chat / RP
34
49
- Branching chat history.
35
50
- Edit, delete, resend, regenerate.
36
51
- Multi-character chats with auto-turns.
37
52
- RP controls: prompt stack, author note, scene state, presets, personas.
38
53
- LoreBook / World Info support, including SillyTavern-compatible world info import/export.
39
-
- Reasoning support, including `<think>...</think>` parsing.
54
+
- Reasoning support, including streamed reasoning fields and `<think>...</think>` parsing.
40
55
- Vision attachments and chat attachments.
56
+
- MCP tool calling for OpenAI-compatible chat/completions providers, with text-tool-call fallback parsing for providers that do not emit native tool calls cleanly.
41
57
42
58
### Writing
43
59
- Projects, chapters, scenes, outlines.
@@ -56,7 +72,10 @@ Desktop app built with Electron, React, a local Express API, and SQLite.
56
72
- OpenAI-compatible providers.
57
73
- KoboldCpp support.
58
74
- Custom endpoint adapters for non-OpenAI / non-Kobold backends.
75
+
- Presets for OpenAI, LM Studio, Ollama, KoboldCpp, OpenRouter, and custom OpenAI-compatible endpoints.
76
+
- Manual fallback models for providers whose `/models` endpoint is missing, empty, or provider-specific.
59
77
- Separate models for translate / compress / TTS / RAG.
78
+
- API parameter forwarding controls for providers that reject unsupported sampling fields.
60
79
61
80
### Plugins / Extensions
62
81
- Toolbar tabs from plugins.
@@ -72,7 +91,7 @@ Desktop app built with Electron, React, a local Express API, and SQLite.
72
91
73
92
74
93
## Requirements
75
-
- Node.js + npm.
94
+
- Node.js + npm. Node.js 20+ is recommended because CI builds with Node 20.
76
95
- Python 3 + Pillow for icon generation:
77
96
78
97
```bash
@@ -148,6 +167,12 @@ Windows only:
148
167
npm run dist:win
149
168
```
150
169
170
+
Linux AppImage only:
171
+
172
+
```bash
173
+
npm run dist:linux
174
+
```
175
+
151
176
Build output goes to `release/`.
152
177
153
178
## GitHub Actions
@@ -156,8 +181,8 @@ Workflow:
156
181
-`.github/workflows/build-desktop.yml`
157
182
158
183
What it does:
159
-
- builds macOS (`x64`, `arm64`)and Windows (`x64`) bundles,
160
-
- uploads artifacts,
184
+
- builds macOS (`x64`, `arm64`), Windows (`x64`), and Linux (`x64` AppImage) bundles,
185
+
- uploads workflow artifacts,
161
186
- publishes GitHub Release assets on `v*` tag pushes.
Copy file name to clipboardExpand all lines: docs/vellium/README.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,11 @@ Vellium is a local-first desktop/workbench app for:
8
8
- long-form writing workflows
9
9
- characters and LoreBooks
10
10
- knowledge collections and RAG
11
+
- autonomous agent workflows over a selected workspace
11
12
- MCP / tool calling
12
13
- local plugins and themes
13
14
14
-
This guide documents the current UI and is based on the real app areas: `Welcome`, `Chat`, `Writing`, `Characters`, `LoreBooks`, `Knowledge`, `Settings`, and plugin-powered surfaces.
15
+
This guide documents the current UI and is based on the real app areas: `Welcome`, `Chat`, `Writing`, `Agents`, `Characters`, `LoreBooks`, `Knowledge`, `Settings`, and plugin-powered surfaces.
15
16
16
17
The screenshots in this guide are local captures from the current app build. Where it makes onboarding clearer, they use `Simple Mode` so the first-run flow matches what many users will actually see.
|`Agents`| Ask/build/research workflows over a workspace with tools, traces, and resumable runs |`Settings`, provider profiles, workspace/tool security |
55
59
|`Characters`| Importing and editing character cards |`Chat`, `Writing`|
56
60
|`LoreBooks`| World facts, trigger keys, scripted prompt injections |`Chat`|
57
61
|`Knowledge`| Retrieval collections for RAG |`Chat`, `Writing`, `Settings`|
@@ -66,13 +70,15 @@ flowchart LR
66
70
4. Add or import a character in `Characters`.
67
71
5. If your workflow needs world facts, create a LoreBook.
68
72
6. If your workflow needs retrieval, create a knowledge collection in `Knowledge`.
69
-
7. Only after that move on to multi-character scenes, writer workflows, plugins, and MCP.
73
+
7. For workspace automation, create an `Agents` thread after providers and tool/security settings are configured.
74
+
8. Only after that move on to multi-character scenes, writer workflows, plugins, and MCP.
70
75
71
76
## Important Things to Know Up Front
72
77
73
78
- Vellium is not tied to a single backend. Chat, translation, compression, TTS, and RAG can all use different models.
74
79
-`Local-only mode` limits the app to localhost or private-network endpoints.
75
80
- Tool calling through MCP only works with OpenAI-compatible chat/completions providers, not with KoboldCpp.
81
+
- Agents can use first-party workspace tools when enabled. Command execution, network commands, destructive file operations, and git writes are separately gated in settings.
76
82
-`Knowledge` and `LoreBooks` solve different problems: one is retrieval-based, the other is trigger-based scripted context.
77
83
- Plugins in Vellium are local extensions. Treat their permissions the same way you would treat shell tools or third-party scripts.
0 commit comments