docs: add a GitHub Copilot app walkthrough

Open
#2,431 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
github, typescript
Domain
documentation

Research direction

Start with the existing Choose your interface, Using Squad across clients, and host feature matrix pages, then read .squad-templates/spawn-reference.md and the changelog entries for #1385, #1461, and #1517. Verify each walkthrough step in the current GitHub Copilot app, including worktree branch behavior and the picker’s interaction with per-agent model selection in #2258. Add the new page, update the three listed documentation pages and feature matrices, then run the docs build and checks; confirm the installation step uses release assets under github/squad/releases.

Written by the indexing model from the issue text.

Description

documentation squad squad:docs-devrel

Problem

The docs don't explain how to use Squad in the GitHub Copilot app.

  • Choose your interface lists the Copilot CLI, VS Code, the Squad CLI, the SDK and @copilot, but not the app.
  • Using Squad across clients has walkthroughs for six other clients, but not the app.
  • How Squad behaves in the app is described only in the coordinator's spawn reference (.squad-templates/spawn-reference.md, "Sub-Sessions (Copilot App Mode)") and in the changelog entry for #1385. #1118 asked how Squad works with the app and was answered only in that thread.

What a new user ran into (2026-11-08)

  1. "Custom agent 'squad' not found." A new worktree session failed with session construction failed: Custom agent 'squad' not found. The files from squad init hadn't been committed and pushed, so the worktree had no .github/agents/squad.agent.md. Pushing first, or starting the session on the existing branch, fixed it.
  2. Casting stopped after the roster was approved. The setup agent stopped without changing any files and showed "Squad coordinator (squad.agent.md) appears to be missing or truncated. The canary token was not found." That is the exact wording of the canary check Squad shipped before v0.13.1 (#1461, fixed by #1517). The old check stops every agent the coordinator spawns, because spawned agents never carry the coordinator canary. A stale copy of an old copilot-instructions.md was probably in the repository or in the user's personal Copilot instructions.
  3. Agents showed up in two places. Some appeared as sub-sessions in the sidebar and others as background agents, with nothing explaining why. This is by design: the coordinator uses create_session for work that makes commits and task for read-only work.

Deliverable

A walkthrough page for the GitHub Copilot app that covers:

  1. Installing the Squad CLI and running squad init, linking to Installation.
  2. Committing and pushing the squad init output before starting worktree sessions, or starting the session on the existing branch instead. Check whether the app builds worktrees from the local or the remote branch and word the step to match.
  3. Opening the repository, starting a session, choosing the Squad agent (/agent squad), and describing the project so the coordinator can cast the team.
  4. Where agents show up: sub-sessions (nested in the sidebar, each with its own worktree) for work that makes commits, and background agents for read-only work. Include the limits: one level of nesting and about 4–5 sub-sessions at a time.
  5. What the app's model, effort and context-window picker controls, and how it interacts with Squad's per-agent model selection (see #2258).
  6. A troubleshooting section covering the three problems above.
  7. Adding the app to Choose your interface (the list and the feature matrix), the host feature matrix and Using Squad across clients.

Acceptance criteria

  • Every step is checked in the current GitHub Copilot app, not inferred from the coordinator templates.
  • The docs build and the docs checks pass.
  • The install step works on the day the page ships. Today the Homebrew cask and the WinGet manifest for 1.1.0 download from bradygaster/squad/releases, which has returned 404 since the repository move. The same assets exist under github/squad/releases.

Out of scope

A page presenting Squad as a "software factory" (gh-aw workflows, squad watch --execute, Ralph, @copilot). That needs a maintainer decision first: #2430.

Dominant language
TypeScript
Stars
3.4k
Forks
516
Avg merge
1d 15h
Merged PRs (30d)
116

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/squad

All issues in github/squad

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.