From d5bc94ccdf9b257a3b8eac5fe1af4c1d29b423aa Mon Sep 17 00:00:00 2001 From: Dina Berry Date: Sun, 8 Mar 2026 15:57:49 -0700 Subject: [PATCH] docs: add installation method decision tree Adds a 'Which method should I use?' decision table to the installation guide, helping new users choose between CLI (npx/global), VS Code extension, and SDK based on their goals. Closes #287 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/get-started/installation.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/get-started/installation.md b/docs/get-started/installation.md index e1c4fafaa..65d916532 100644 --- a/docs/get-started/installation.md +++ b/docs/get-started/installation.md @@ -59,6 +59,21 @@ npm install -g @bradygaster/squad-cli@latest --- +## Which method should I use? + +Pick based on what you're doing: + +| **You want to...** | **Use** | **Why** | +|--------------------|---------|---------| +| Try Squad quickly | **CLI** with `npx` | No install needed. Run `npx @bradygaster/squad-cli init` and you're testing it. | +| Use Squad across all projects | **CLI** with `--global` | One install. Works everywhere. Run `squad` from any terminal. | +| Work inside VS Code | **VS Code** (just open your project) | Already using Copilot? Squad just works. Same `.squad/` directory as CLI. | +| Build tools on top of Squad | **SDK** | Typed APIs, routing config, agent lifecycle hooks. Programmatic access to everything. | + +Can't decide? → Start with **CLI**. You can always add VS Code or the SDK later. Your `.squad/` directory works identically everywhere. + +--- + ## 2. VS Code Squad works in VS Code through GitHub Copilot. Your `.squad/` directory works identically in both CLI and VS Code — same agents, same decisions, same memory.