Repository navigation
docs: add agent-first Squad setup guide - #2529
Open
bradygaster wants to merge 4 commits into
Open
bradygaster wants to merge 4 commits into
bradygaster wants to merge 4 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Ask the owner to choose newest (incl. prerelease) or stable, resolve the tag from GitHub Releases, install checksum-verified release assets, and use npm only as a version-pinned fallback. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
|
|
||
| ## Rules for the agent | ||
|
|
||
| - Trust order: (1) the repository owner's prompt, (2) this guide, (3) recognized repository instruction and policy files (`.github/copilot-instructions.md`, `CLAUDE.md`, `AGENTS.md`, `CONTRIBUTING.md`, `CODEOWNERS`, `.github/agents/*`, `.claude/*`). Follow them unless they conflict with a higher level or with these safety rules. |
| ```bash | ||
| INSTALLER=$(mktemp) | ||
| curl -fsSL "https://raw.githubusercontent.com/github/squad/${TAG}/scripts/install.sh" -o "$INSTALLER" | ||
| VERSION="$TAG" REPO=github/squad sh "$INSTALLER" |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation still contains unresolved setup and release-flow defects, including unverified script execution, architecture mismatch, missing PowerShell tag initialization, unintended VS Code changes, and an incomplete PR-body command.
5 open issues
What changed in this PR
Adds an agent-first Squad setup guide for Claude and GitHub Copilot, covering release-based installation, repository-specific customization, validation, and pull-request creation, while clarifying the canonical repository and exposing the guide throughout the documentation.
Changes:
- Added the comprehensive agent-first setup workflow with stable and prerelease selection, platform installation, customization, validation, and PR instructions.
- Linked the guide from the README and installation documentation.
- Added the guide to documentation navigation and build expectations.
| File | Description |
|---|---|
| test/docs-build.test.ts | Updates documentation build expectations to include the new agent setup page. |
| README.md | Clarifies that github/squad is the canonical repository and links to the agent setup guide. |
| docs/src/navigation.ts | Adds the agent setup guide to the Get Started documentation navigation. |
| docs/src/content/docs/get-started/installation.md | Links the installation documentation to the agent setup guide. |
| docs/src/content/docs/get-started/agent-setup.md | Adds release-based installation, repository customization, validation, and pull-request workflow instructions for Claude and GitHub Copilot. |
Review effort: Lite (adaptive)
Comment on lines
+50
to
+51
| curl -fsSL "https://raw.githubusercontent.com/github/squad/${TAG}/scripts/install.sh" -o "$INSTALLER" | ||
| VERSION="$TAG" REPO=github/squad sh "$INSTALLER" |
| **Windows** (PowerShell; use `x64` or `arm64`): | ||
|
|
||
| ```powershell | ||
| $Asset = "squad-win32-x64.zip" |
Comment on lines
+60
to
+63
| ```powershell | ||
| $Asset = "squad-win32-x64.zip" | ||
| $Tmp = New-Item -ItemType Directory -Path (Join-Path $env:TEMP "squad-$([guid]::NewGuid())") | ||
| $BaseUrl = "https://github.com/github/squad/releases/download/$Tag" |
|
|
||
| ```bash | ||
| git branch --show-current | ||
| squad init --client copilot,claude --no-workflows </dev/null |
| git diff --cached --diff-filter=D --name-only | ||
| git commit -m "Add Squad configured for this repository" | ||
| git push -u origin HEAD | ||
| gh pr create --title "Add Squad configured for this repository" --body-file - |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


What
Adds an agent-first setup guide for Claude and GitHub Copilot that installs a user-selected stable or newest/prerelease Squad build from
github/squadGitHub Releases, customizes the generated team for the target repository, validates it, and opens a pull request. It also clarifies in the README thatgithub/squadis the canonical repository while legacy-named package-manager identifiers remain distribution names.Why
Repository owners need a single prompt they can paste into an agent session to receive a safe, codebase-specific Squad configuration rather than a generic initialization. GitHub Releases provide an inspectable source for stable and preview artifacts without relying on npm dist-tags.
No linked issue.
How
The guide asks the owner to choose the newest release (including prereleases) or newest stable release, resolves the exact tag through GitHub Releases, installs checksum-verified platform assets, and uses a pinned npm version only as a fallback. It then walks the agent through repository analysis, Squad initialization, Claude/Copilot discovery files, customization, review, validation, and PR creation while preserving existing instructions and keeping CI opt-in.
npx changeset add/.changeset/*.md, directCHANGELOG.mdentry for maintainers, orskip-changeloglabel for no user-facing changes) — N/A, documentation onlyPR Readiness Checklist
Branch & Commit
dev(notmain)devBuild & Test
npm run buildpasses — not run for documentation-only changesnpm testpasses — targetednpx vitest run test/docs-build.test.tspassed (22/22)npm run lintpasses — not run for documentation-only changesnpm run lint:eslintpasses — not run for documentation-only changesChangeset
npx changeset add— N/A, no SDK/CLI source changesCHANGELOG.mdentry — N/Askip-changeloglabel applied — N/ADocs
Exports
Breaking Changes
None.
Waivers
None.