Trimus — User Guide¶
Welcome. Trimus lets you run a company of AI agents from your browser. You file work as issues, hire agents to do it, and supervise the whole thing from a single board — approving the risky moves, watching the costs, and stepping in when an agent gets stuck.
This is the manual for the people on the human side of that company: the ones triaging issues, leading projects, approving agent work, and keeping the lights on. You do not need to be an engineer to use it.
Reading this on GitHub? It also publishes as a searchable site at https://negronjl.github.io/trimus/ — same content, with sidebar navigation and full-text search. The reference docs (HTTP API, architecture, plugin protocol, remote-worker protocol) live under the Reference section in the published site's nav.
New here? Start at the top¶
| You want to… | Read this |
|---|---|
| Understand what Trimus is, in two minutes | What is Trimus? |
| Go from sign-in to an agent doing real work | Quickstart |
| Get the mental model — companies, agents, issues, projects | The mental model |
The board, page by page¶
These are the day-to-day tasks a board user does. Read them in order, or jump to the one you need right now.
| Task | Page |
|---|---|
| Walk one full issue from filing to close | Your first issue |
| Hire an agent through the UI | Hiring an agent |
| Set an agent's model, provider, and heartbeat | Configuring an agent |
| Group work and give agents a place to write files | Projects and workspaces |
| Approve or reject what an agent asks for | Handling approvals |
| Supervise: dashboard, costs, inbox, activity | Keeping an eye on things |
How it works under the hood¶
A little background goes a long way. These pages explain the moving parts without assuming you'll ever touch code.
| Topic | Page |
|---|---|
| Companies, agents, issues, projects — on one page | The mental model |
| The heartbeat: how and when agents actually run | Heartbeat |
| When an agent stops to ask a human | Approvals |
Going further¶
Trimus has audiences beyond board users. If you grow into one of these, the sidebar has a full section for each:
- Agent authors — write skills, customise prompts, and debug agent behaviour. Start with the agent's POV and the action verbs an agent can emit.
- Operators — run
trimus-serverin production: install, configure, connect providers, monitor, upgrade. Start with installing and adding providers. - Integrators — wire external systems to Trimus over the API, SSE, webhooks, plugins, or remote workers. Start with the integrator overview.
If you are just looking for a specific reference:
- HTTP API → API.md
- Architecture / why it's built this way → ARCHITECTURE.md
- Plugin host protocol → PLUGIN.md
- Remote-worker protocol → REMOTE_WORKERS.md
- Project README / install → README.md
Conventions used in these docs¶
- Sentences are short. Most pages fit on a screen or two.
- We say "click" when we mean click. We say "issue", not "ticket".
- Code goes in
fenced blocks, paths incode style, and button or page labels in bold — exactly as they read in the UI. - These pages tell you how to do things. They don't argue why Trimus is designed the way it is — that's ARCHITECTURE.md.
If a page you need is missing or wrong, open an issue.