docs: add a GitHub Copilot app walkthrough
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- github, typescript
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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)
- "Custom agent 'squad' not found." A new worktree session failed with
session construction failed: Custom agent 'squad' not found. The files fromsquad inithadn'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. - 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.mdwas probably in the repository or in the user's personal Copilot instructions. - 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_sessionfor work that makes commits andtaskfor read-only work.
Deliverable
A walkthrough page for the GitHub Copilot app that covers:
- Installing the Squad CLI and running
squad init, linking to Installation. - Committing and pushing the
squad initoutput 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. - Opening the repository, starting a session, choosing the Squad agent (
/agent squad), and describing the project so the coordinator can cast the team. - 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.
- What the app's model, effort and context-window picker controls, and how it interacts with Squad's per-agent model selection (see #2258).
- A troubleshooting section covering the three problems above.
- 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 undergithub/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.
- Lingua principale
- TypeScript
- Stelle
- 3.4k
- Fork
- 516
- Merge medio
- 1g 15h
- PR unite (30g)
- 116
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/squad
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di github/squad
Issue simili
-
bot:ai-assisted component:platform-js status:untriaged
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 74/100
midnightntwrk/platform-js#38 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
ranxianglei/billion-context#7068 ·
I maintainer di solito rispondono entro 1 giorno
-
vendor: bump whisper.cpp past 6a8addd — the current pin aborts the app on a failed Metal initAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
mybigday/whisper.rn#348 ·
-
enhancement severity:low
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
Battle-Cattle/BCUK-Bot-4#1075 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 67/100
ilan-pinto/roaring-lions#1552 ·
I maintainer di solito rispondono entro 1 giorno