squad

(โ˜… 3,113)

Squad: AI agent teams for any project

  • .dockerignore
  • .gitattributes
  • .gitignore
  • .lycheeignore
  • .markdownlint-cli2.jsonc
  • .npmignore
  • CHANGELOG.md
  • cli.js
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • cspell.json
  • Directory.Build.props
  • Dockerfile
  • eslint.config.mjs
  • index.cjs
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • README.zh.md
  • SECURITY.md
  • Squad.Agents.AI.slnx
  • squad.config.ts
  • SUPPORT.md
  • tsconfig.json
  • vitest.config.ts

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/bradygaster/squad

Downloads the entire project code from GitHub to your computer.

cd squad

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g @bradygaster/squad-cli

Installs the package published on the npm registry globally โ€” no need to clone the source.

npm install -g @bradygaster/squad-cli@latest

Installs the package published on the npm registry globally โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f test-fixtures/dogfood/mixed-lang/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/Squad.Agents.AI

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

โœ… After dotnet run, check the message or address shown in the terminal.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g @bradygaster/squad-cli

Installs the package published on the npm registry globally โ€” no need to clone the source.

npm install -g @bradygaster/squad-cli@latest

Installs the package published on the npm registry globally โ€” no need to clone the source.

npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

npm run dev:link

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

6. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r test-fixtures/dogfood/mixed-lang/backend/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

7. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd test-fixtures/dogfood/go-project

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

8. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd test-fixtures/dogfood/go-project

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation