Documentation
Start with the project README for installation and basic usage.
On this page: Use Albedo, Operate the daemon, Contribute to Albedo, Develop API clients, and Read the generated API reference.
Use Albedo
- Install: with Nix or from source, then the first run.
- Web client: open the canvas in a browser and reach it from your other devices.
- Discord: connect a Discord bot, configure channels and mentions, and manage DM requests.
- Webhooks: accept signed HTTP webhooks, verify signatures, and rotate secrets.
- Skills and instructions: write
SKILL.mdskills, loadAGENTS.mdinstructions, and invoke/skillcommands. - MCP servers: configure stdio and HTTP MCP servers, environment references, and OAuth.
- Agents, worktrees, and workflows: have agents work
in parallel, isolate
jjandgitcheckouts, share/work, and schedule prompts. - Artifacts: build versioned interactive HTML apps beside chat.
- Remote kernels: run an agent's commands and files on another machine over SSH while Albedo stays on yours.
- Remote, Colab, browser, and desktop: work on SSH hosts, Colab GPUs, web pages, and desktop apps.
Operate the daemon
- Daemon attachment and local startup: discovery, startup, restart, and login services.
- Manage Albedo with home-manager: declarative installation and user services.
Contribute to Albedo
- Repository instructions: tools, tests, UI review, and contribution workflow.
- Change Albedo: ownership, lifecycle, storage, and provider rules.
- Robot documentation: subsystem behavior and links to its implementation.
- Write an extension: a worked Gleam example with tables, a Python binding, a command, a hook, moves, and cleanup, plus settings, host routes, and resource ownership.
- Extension API reference: public SDK function documentation and the generated signature and type reference.
Develop API clients
- OpenAPI contract: request, response, and stream shapes.
- HTTP API behavior: shared HTTP rules, settings, history, discovery, and runtime changes.
- Session lifecycle and recovery: creation, durable input, cancellation, shell commands, and side questions.
- HTTP streams and recovery: session replay, reset, progress, collection invalidation, and overflow.
- Extension HTTP behavior: workspace scope, permissions, notifications, and one-time secrets.
- API architecture: state ownership and persistence boundaries.
- Change the HTTP API: contract ownership, implementation rules, and validation.
- Client API ownership: named operations, typed results, and transport recovery.
Read the generated API reference
Run python3 scripts/api-reference.py from the repository root, then open
docs/api-reference.html in a browser. The
generator embeds the current contract and pins
the Scalar version. Viewing the page requires JavaScript and access to its CDN.
The generated HTML is ignored by Git.
- HTTP workflows: create, submit, watch, edit, and recover.
- Generated consumer references: client, extension, and transfer.
Next install