Skip to content

docs: add agent-first Squad setup guide - #2529

Open
bradygaster wants to merge 4 commits into
devfrom
bradygaster-psychic-parakeet
Open

bradygaster wants to merge 4 commits into
devfrom
bradygaster-psychic-parakeet

Conversation

@bradygaster

Copy link
Copy Markdown
Collaborator

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/squad GitHub Releases, customizes the generated team for the target repository, validates it, and opens a pull request. It also clarifies in the README that github/squad is 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.


⚠️ Quick Check

  • If SDK/CLI source files changed: completed the applicable Changeset step below (npx changeset add / .changeset/*.md, direct CHANGELOG.md entry for maintainers, or skip-changelog label for no user-facing changes) — N/A, documentation only

PR Readiness Checklist

The PR readiness bot will validate these automatically after push.
Check each item before requesting review. See CONTRIBUTING.md for full details.

Branch & Commit

  • Branch created from dev (not main)
  • Branch is up to date with dev
  • Verified diff contains only intended changes
  • PR is not in draft mode
  • Commit history is clean

Build & Test

  • npm run build passes — not run for documentation-only changes
  • npm test passes — targeted npx vitest run test/docs-build.test.ts passed (22/22)
  • npm run lint passes — not run for documentation-only changes
  • npm run lint:eslint passes — not run for documentation-only changes
  • For migration PRs (>20 files): N/A

Changeset

  • Changeset added via npx changeset add — N/A, no SDK/CLI source changes
  • Or direct CHANGELOG.md entry — N/A
  • Or skip-changelog label applied — N/A

Docs

  • README section updated
  • Docs feature page added

Exports

  • package.json subpath exports updated — N/A, no SDK changes

Breaking Changes

None.

Waivers

None.

bradygaster and others added 4 commits November 17, 2026 19:59
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>
Copilot AI adaptive review requested due to automatic review settings November 17, 2026 20:32

## 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"

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants