Skip to content

docs: update local development setup documentation #1059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bradygaster merged 1 commit into from
May 12, 2026
Merged

docs: update local development setup documentation #1059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,32 @@ Use `--force` to re-apply updates even when your installed version already match

---

## Local Development Installation

To install and run Squad from source for development:
Comment thread
bradygaster marked this conversation as resolved.
Resolved

```bash
# Clone the repository
git clone https://github.com/bradygaster/squad.git
cd squad

# Install dependencies (npm workspaces)
npm install

# Build the project (SDK first, then CLI)
npm run build

Comment thread
bradygaster marked this conversation as resolved.
Resolved
# Run the CLI directly
node ./packages/squad-cli/dist/cli-entry.js init

# Or link it globally for convenience
npm run dev:link
```

After `npm run dev:link`, the `squad` command will be available globally and will use your local build. To update after code changes, re-run `npm run build` to recompile.

---

## All Commands (17 commands)

| Command | What it does |
Expand Down
14 changes: 6 additions & 8 deletions docs/src/content/docs/guide/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,9 @@ npm workspaces automatically links local packages. `@bradygaster/squad-cli` can
### 2. Build

```bash
# Compile TypeScript to dist/
# Compile TypeScript for both packages (SDK + CLI)
npm run build
Comment thread
bradygaster marked this conversation as resolved.
Resolved

# Build + bundle CLI (includes esbuild)
npm run build:cli

# Watch mode (auto-recompile on changes)
npm run dev
```
Comment thread
bradygaster marked this conversation as resolved.
Resolved
Expand Down Expand Up @@ -191,16 +188,17 @@ This convention makes `squad version` show the preview tag locally, clearly indi
To make the `squad` CLI command globally available and pointing to your local development build:

```bash
npm run build -w packages/squad-sdk && npm run build -w packages/squad-cli
npm link -w packages/squad-cli
npm run dev:link
```

After this, `squad version` will show `0.8.6-preview` (or the current preview version). When you make code changes and rebuild, the `squad` command automatically picks up the changes—no need to reinstall. To verify your local build is active, the version output should include the `-preview` tag.
This builds both packages and runs `npm link` to make `squad` available globally pointing to your local source.

When you make code changes, re-run `npm run build` to recompile. No need to re-link — the linked package automatically picks up changes.

To revert back to the globally installed npm package version, run:

```bash
npm unlink -w packages/squad-cli
npm run dev:unlink
```

## Changesets: Independent Versioning
Expand Down
Loading