Search documentation
The durable search route: every result the overlay can show, plus the full route index when JavaScript is off.
The query field above searches every page. The list includes every documentation route below, grouped by section, and that list works with JavaScript off.
Start here
- Start here Get from nothing to a running channel: install the CLI, join or set up a workspace, and create your first channel.
- Your first melt Create a channel, describe a small change and inspect the response without assuming an automatic agent team.
- Joining a workspace Find your channels, read the people and agents present, and record a first request.
- Set up your workspace Find workspace settings, check who is present and create the first channel without assuming a fixed agent team.
- Install the CLI One command puts the `crusible` binary on your machine, after it verifies the release signature and the checksum in front of you.
- Your first worktree channel Create a channel with a machine, run a command and attach a file.
Concepts
- Concepts What a channel is, who holds the record, and how a surface answers to the conversation that opened it.
- Channels are units of work Keep a conversation and its related tools together around a piece of work.
- The conversation is the record Messages, decisions and linked work share a channel without replacing their source records.
- Every surface has a provider How providers, conversation bridges and embedded links differ.
- Surfaces answer to the conversation Inspect documents, files and proposed changes alongside the channel conversation.
- Agents are teammates Agents work through attributed requests, replies and tools, with access bounded by the work they can perform.
- The signal dial Channel attention, folded updates and notification delivery are separate controls.
Guides
- Guides Steps for someone who already knows what they want — grouped by the job you are on, not by the surface you happen to be in.
- Work with agents Address a request, inspect its result and recover a stopped or failed reply.
- Work with messages Reply, edit, attach files, annotate images and forward a message without losing its context.
- Share a secret Send a password, token or key as a sealed card that only the people you choose can reveal, and see who revealed it.
- Join a huddle Start or join audio, check your microphone, invite people and leave.
- Join a standup Enter a recorded standup, read its recording signal and speak or listen in the session.
- Create a channel Name a channel, describe its purpose and post the work you want to discuss.
- Use the task board Find an issue, save a board view, create and organise work, then check an assignment and follow its comments or linked pull request.
- Go solo Give the conversation the whole window when talking is the work, and give the surface the whole window when looking at one thing is the work.
- Archive a channel Archive a finished channel to take it out of everyone's channel list, keep its conversation readable, and unarchive it when work resumes.
- Set the signal dial Choose Everything, Mentions, Decisions or Muted for your channel attention.
- Work the inbox Read the notification inbox in its order, open each entry where it happened, and mark read or clear what you have handled.
- Direct a message to one agent Mention an agent in a channel or use its direct conversation, with the request kept on record.
- Act on a pending-decision card Read a question, answer it and check whether that answer reached the agent.
- Review agent suggestions in docs Open the suggestions waiting on a doc, read each one beside the text it changes, and accept or reject it block by block.
- Create and share a document Create a linked document in a channel, add content and copy its link for people who already have access.
- Review a pull request Read a pull request, inspect its files and checks, and continue review actions on GitHub.
- Share a preview Expose a port in your Sandbox through a tunnel, share its link, and revoke the tunnel when you finish.
- Have an agent operate a connected tool Request connected-tool work and verify the external result.
- Work in a surface backed by an external tool Work with a GitHub-backed pull request and verify the result.
Reference
- Reference Every surface, provider and bridge Crusible documents, plus the flat pages that belong to no family.
- Surfaces Every surface, what each one shows, and which channel kind turns it on.
- Terminal Shells, machine selection, terminal tabs, file uploads and connection controls.
- Project Mounted files, editing, working changes and comparisons for the channel.
- Docs Collaborative channel documents, linked pages, editing modes and suggestions, with access inherited from the channel.
- Forge Repository browsing, its current limits, and the related file and review surfaces.
- Review Pull requests, changed files, checks and reviewer status for the channel’s connected repository.
- Issues Issue lists, saved board views, editable attributes, dependencies and activity, with the boundaries between filing an issue and asking the agent to work on it.
- Roadmap A read-only timeline of the workspace's roadmap items and milestones, with the dependencies between them.
- Providers Available connections and the limits of the provider catalogue.
- MCP MCP terminology and the limits of generic tool connections.
- Notion Notion connection availability and current limits.
- Linear Linear connection availability and current limits.
- GitHub GitHub App installation, access, records, refresh and disconnect.
- Sentry Sentry connection availability and current limits.
- Bridges Conversation bridges, current availability and setup limits.
- Slack Slack bridge availability and the distinction from incoming alerts.
- Agents Forge and Compass, the 2 agents you can address, and the other named agent roles with their pages.
- Forge Forge answers direct messages and channel mentions, uses web tools, and works on issues assigned to a Sandbox.
- Compass Compass researches a question on the web and writes a cited answer into a document, within limits set for each channel.
- Conversation controls Messages, threads, reactions, forwarding, presence, link previews and image annotation in a channel.
- Channel settings Channel membership, access and personal attention controls.
- Account usage What the application reports about usage and which billing and export controls remain unavailable.
- Huddles and standups Audio sessions, invitations, sharing and the difference between unrecorded huddles and recorded standups.
- Composer Message text, mentions, references, uploaded files and sending controls.
- States and priorities Message priorities, attention levels and decision delivery states.
- Glossary Every coined word in these docs, defined once: channels, surfaces, providers, agents, priorities and whose store holds the record.
- Verify a download What a Crusible CLI release contains, what each checksum, signature and attestation proves, and what it means when one of them does not match.
- Notifications Channel attention, in-app notices and email or push preferences.
- Keyboard shortcuts The keyboard shortcuts in the web app, by platform, as the help panel and the command palette define them.
- App updates and language How the web app finds and applies a new version, where What's new appears, and which interface languages the language menu offers.
Troubleshooting
- Troubleshooting Symptoms you can see right now, matched to the fix — a machine that idled out, a channel stuck at blocked, a connection that failed.
- A machine shows “Lost the link” Crusible dropped the connection to a machine and is retrying. What is safe, what to read while you wait, and when to bring in an admin.
- A machine idled out The machine suspended after a quiet spell and saved its state. What that message means in plain language, and how to bring the machine back.
- A run awaits a person A decision needs an answer, or the terminal has not confirmed the answer you sent.
- A channel shows “Blocked” The channel's state says something in it is waiting. How to read what it is waiting on, and which of the two causes you are looking at.
- Huddle audio or connection is not working Check microphone permission, selected devices, speaker output and session access.
- Sign-in or invitation problems Recover a password, replace an invitation link or identify when an organisation owner needs to help.
- A message is missing from a channel Check the destination, folded updates, access and delivery before assuming someone deleted a message.
- A connection failed or lacks a scope Diagnose GitHub installation, repository access and permission refusals.
- A control in a guide is not visible Check the view, access messages and feature availability when a guide names a missing control.
- A suggestion in Docs will not accept Accept does nothing on a suggested block. Check editing access, connection state and whether the proposal is still pending before trying again.
- A connected surface is not showing data Check GitHub source data, freshness and installation access.
Admin
- Admin Set the workspace up, connect tools, decide what agents may do, and run it day to day.
- Set up single sign-on Configure an organisation identity provider, test sign-in and activate the connection.
- Manage sign-in sessions Review your browser sessions and revoke access from a device you no longer use.
- Secure your sign-in Confirm it's you before a protected change, and get back in after you lose your authenticator app.
- Remove a member Remove a colleague’s workspace access and understand what remains.
- Connect a compute provider Check the availability of provider connections and find the machine controls.
- Set a sandbox environment Set the environment variables and secrets every Sandbox starts with, for your organisation or for yourself.
- Invite people and set roles Invite colleagues from Directory and change an active member’s access from their profile.
- Connect a provider Install the GitHub Forge and Lens Apps and check their connection states.
- Switch a surface's provider Check a connection while general surface-provider switching is unavailable.
- What agents can see and do Agent access depends on the request, channel, tools and permissions; profiles show only part of the access record.
- Settings Personal preferences, organisation controls and the permissions that determine which pages you can open.
- Roles and permissions Organisation roles, settings access and the limits on changing another member’s access.
- Connect Vercel Connect a Vercel team to Crusible, choose projects, and remove it.
- Disconnect a provider Revoke a GitHub App connection and understand what remains.