Documentation
Nexul is a self-hosted workspace for teams that ship software with coding agents. Start with the install, or jump to the area you need.
Get started
- OverviewGo from a fresh server to a deployed stack, then find your way around everything else.
- InstallPut Nexul on a Linux server with one command, or try it on your Mac or Windows PC first.
- Setup wizardGive a fresh instance its domain, connect the GitHub App, and sign in as the owner.
- GitHub AppCreate the GitHub App your instance signs people in with and reads repositories through.
- UpgradeMove the instance to a new release from the web app or the server, roll back, and restore a database snapshot.
- Enterprise licensePaste the license key that unlocks the enterprise features on one instance, see what it covers, and renew it before it runs out.
- Single sign-onLet people sign in through your company's identity provider over OpenID Connect, turn every other sign-in off, and keep the instance Owner's passkey as the way back in.
- BrandingGive an instance its own name, logo, accent colour, VS Code color theme and CSS, so it looks like your own tool.
Deploy
- RunnersAdd the services that build and deploy on your machines, scale them, and remove them.
- Stacks and deploysShip a repository as a stack, set its environment, roll it back, read its logs, and deploy its branches as their own copies.
- External secretsKeep secrets in 1Password and let Nexul hold only a pointer to each one, read by the runner, automations host or server that uses it.
- Topology and DNSSee how your services connect, and give them hostnames through a Cloudflare tunnel or a reverse proxy.
- LogsRead the instance's own logs through Nexul, from an agent or the API, or open the bundled OpenObserve yourself.
Work together
- Projects and repositoriesCreate a project with the wizard, attach the repository it deploys from, and add more services later.
- People and accessInvite people, give them roles in each workspace, and choose who's in each project.
- Welcome wizardWhat a newcomer sets up on their first sign-in, how roles decide the steps, and where an admin sees how far each person got.
- Docs, tickets, and the boardWrite the plan as a doc, break it into tickets, and move them across the project's board to done.
- Chat and voiceTalk in channels and direct messages, bring an agent into the conversation, and jump on a voice call with screen share.
- BotsLet outside tools post into a conversation through a webhook URL. Anything that already posts to a Discord webhook works.
- CalendarPlan meetings in a workspace, invite people, and get a reminder before each one and the day before a ticket is due.
- AutomationsRun your own TypeScript when something happens in a workspace, such as moving a ticket when its pull request merges.
Agents
- Set up a computerRun setup once on a paired computer so its agents can reach Nexul and take on plays and chat mentions.
- Paired computersConnect your own computer running T3 Code so plays and @Agent mentions run there, and choose which computer and model each project uses.
- PlaysPress a play on a ticket, a doc, or a project's interview, or let one start itself when a service crashes, and an agent on a computer does the work, with every step recorded.
- InterviewAnswer a project's interview once and every agent turn in that project reads the rules it produces first.
- MemoriesWrite down what agents should know about a project, and choose which notes every agent turn reads first.
- MCP serverConnect Claude Code, Codex, opencode, or any MCP client to your instance so an agent can work in Nexul with your permissions.
- Triage a bug in NexulAsk your own agent to diagnose a bug in Nexul itself and file it as an issue, with nothing private in it.
Reference
- API and tokensCall the HTTP API with a token, see what each token can do, and sign in a phone or desktop app.
- Desktop appOpen your instance in its own window with the desktop app, connected by a connection token.
- Phone appInstall the Nexul app on your phone and sign in by scanning a code from the web app.
Contributing
- OverviewHow the codebase is organised, how to run it locally, and the standards every change is held to.
- ArchitectureHow Nexul is put together — one Go module, two adapters over a shared use-case layer, and everything around it.
- Repository layoutWhat lives where in the Nexul monorepo.
- Local developmentPrerequisites, make targets, the debug stack, and running tests.
- Coding standardsA digest of the practices that govern Go, MCP, React, the phone app, testing, and visual design in this repo.
- Documentation and ADRsHow CONTEXT.md, the ADRs, the tracker, and the practices files fit together.
- CI and releasesWhat runs on every push, how releases are cut and versioned, and the merge policy.
- This websiteHow the documentation site itself is built and deployed.
- LicensingThe open-core split, what that means for a contributor, and the CLA.