Skip to content

Latest commit

 

History

History
46 lines (40 loc) · 3.5 KB

File metadata and controls

46 lines (40 loc) · 3.5 KB

Switchboard documentation

Documentation for devsuitup/switchboard, a fork of doctly/switchboard. Download links are in the README.

Using the app

Page What it covers
Session browser The sidebar: tabs, projects, session rows, filters, search, pin, archive, stop, delete, missing projects
Launching sessions The "+" menu, the New Session and Resume dialogs, permission modes, fork, plain terminals, sessions live in another process
Worktree sessions claude --worktree from the New Session dialog: where the worktree lands, how it is shown, resume, cleanup
Sandbox Running claude under bubblewrap on Linux: what is isolated, what is not, prerequisites
Terminal Terminal header, right-click modes, context menu, clickable paths, drag and drop, pasting, find, the panel shell
Window The strip that replaces the title bar, the ☰ menu, zoom, full screen
Grid overview All open sessions as live cards, grouped by project or flat
Status indicators What each dot and colour in the sidebar means, and the status bar
Subagents Subagent rows, their live status, the read-only transcript viewer
IDE emulation Switchboard as Claude's IDE: file opens and diffs in a side panel
Changes view A session's git status and diffs, with an editor for local sessions
Agent Files and Work Files The two file tabs: CLAUDE.md and memory files, schedules, .work-files/
Stats Heatmap, totals, per-model tokens, rate limits
Session restore Reopening the open sessions at the next launch
Remote hosts Observing, attaching to and stopping sessions on SSH hosts
Automation Scheduled headless runs, and the trigger API that types into open sessions
ActivityWatch Opt-in reporting of session time to a local ActivityWatch server
Activity trace Debug mode: the trace behind the activity indicators
Settings reference Every setting, its default, its scope, and where it is explained
Keyboard shortcuts Every shortcut, and how to rebind the three that can be
Customizing colors Community guide, in French, to editing the CSS inside app.asar (written against v0.0.30)

Working on the app

Page What it covers
Development Prerequisites, task commands, running from source next to an installed copy, building, project layout
Testing a PR live task test-pr: a PR's code in an isolated instance next to your own, and its pitfalls
Live testing with a throwaway HOME An instance that cannot see your sessions at all, driven by Playwright
Releasing Version bump, tag, draft release, publishing
Changelog Writing a CHANGELOG.md entry, the CI check, the What's new dialog
Decisions Architecture decision records

Code-level documentation for contributors and agents lives in ../.ai/shared-guidelines.md and ../.ai/contexts/.