Community: install once, run anywhere
The community build is a personal assistant. You install it once, keep your
model endpoint and API key in one place, and start it from whatever folder you
are working in.
What lives where
Two independent axes:
| Axis | Meaning | Default (community) |
|---|---|---|
| Instance home | Where conversations, logs, and indexes are stored | $CODUMENTOR_HOME (~/.codumentor) |
| Config layers | What the process believes | Bundled flavor default → user overlay → optional project YAML |
Starting codumentor in ~/src/foo does not write codumentor.yaml or
./data into foo. Chats persist under the user home. Indexes for foo are kept
separate from indexes for ~/src/bar.
Your personal settings (model base URL, API key, auth) live in
$CODUMENTOR_HOME/config.yaml. That file is the user overlay.
Project YAML is an overlay, not the instance
If a directory contains a codumentor.yaml (or the flavor filename) that was
discovered — you did not pass --config — community treats it as a **project
overlay** for that folder:
- It can name repos and project plugins.
- It cannot change your model endpoint or auth. Those stay in the user overlay.
- The first time Codumentor sees that file, it asks whether to trust it.
--configis always trusted and never prompts.--trust-project/--no-trust-projectskip the prompt for this run (--no-trust-projectdoes not remember the skip).
Full-edition workspace servers still treat an on-disk YAML as the instance
when that is the product shape. See the admin configuration
guide for the two axes.
Conversations
The sidebar defaults to This folder on a user-home instance: chats tagged
with the current workspace. All shows every conversation, including
untagged ones from before this filter existed.
Flags
| Flag | Effect |
|---|---|
| `--home user\ | workspace\ |
--ephemeral | Shortcut for --home ephemeral |
--config PATH | That YAML is the instance (trusted; usually workspace home) |
--trust-project / --no-trust-project | Accept or skip a discovered overlay without prompting |