CLI Reference
Complete reference for the squads command-line tool.
npm install -g squadssquads add <sources...>
Install squads into your project from multiple sources simultaneously — GitHub repositories, local directories, or the squads.sh registry. Squads are downloaded, validated, and placed in your project's squads directory.
squads add <sources...> [options]--skill <name>Specify which squad to install when repo has multiple squads-a, --agent <name>Install a specific agent from the squad-g, --globalInstall globally instead of in the current project-y, --yesSkip confirmation prompts--aios <mode>AIOS integration mode: new (create project) or existing (use current)--aios-path <path>Path to the AIOS project (for existing mode)Install from GitHub
squads add owner/repoInstall from local directory
squads add ./my-squadInstall from registry
squads add design-systemInstall multiple squads at once
squads add slug1 slug2 slug3Install into a new AIOS project
squads add my-squad --aios newInstall into an existing AIOS project
squads add my-squad --aios existingInstall a specific agent
squads add my-squad --agent designersquads find [query]
Search the marketplace for squads by keyword. Returns a list of matching squads with install counts and ratings.
squads find [query] [options]-l, --limit <n>Maximum number of results (default: 20)Search by keyword
squads find "design system"List all squads
squads findsquads list (ls)
List all squads installed in the current project. Shows name, version, agent count, and installation path.
squads list [options]-g, --globalList globally installed squadsList installed squads
squads listList globally installed squads
squads list --globalsquads check
Validate all installed squads. Checks for structural integrity, missing files, and broken cross-references.
squads checkCheck installed squads
squads checksquads update [squad]
Update one or all installed squads to their latest version. Without a squad name, updates all squads.
squads update [squad] [options]-y, --yesSkip confirmation promptsUpdate all squads
squads updateUpdate a specific squad
squads update design-system-squadsquads remove (rm) <squad>
Remove an installed squad from your project. Cleans up the squad directory and any synced slash commands.
squads remove <squad> [options]-y, --yesSkip confirmation promptsRemove a squad
squads remove old-squadRemove without confirmation
squads remove old-squad -ysquads init [name]
Initialize a new squad project with scaffolding. Creates the directory structure, squad.yaml, and starter agent/task/workflow files.
squads init [name] [options]-y, --yesSkip confirmation prompts and use defaultsCreate a new squad
squads init my-squadCreate with defaults
squads init my-squad -ysquads validate [path]
Run deep validation on a squad directory. Checks 6 weighted categories (manifest, structure, agents, tasks, workflows, cross-references) and produces a score from 0 to 100.
squads validate [path] [options]--jsonOutput raw JSON report--fixAuto-fix common issues before validatingValidate current directory
squads validateValidate a specific squad
squads validate ./squads/my-squadJSON output
squads validate --jsonAuto-fix then validate
squads validate --fixsquads fix [path]
Auto-fix common validation issues in a squad. Fixes frontmatter format, archetypes, types, tone, and greeting levels. Use --dry-run to preview changes without modifying files.
squads fix [path] [options]--dry-runShow what would be fixed without modifying filesAuto-fix current squad
squads fixFix a specific squad
squads fix ./squads/my-squadPreview fixes
squads fix --dry-runsquads publish [squad-name]
Publish squads to the squads.sh marketplace. Select multiple squads at once and choose target repository.
squads publish [squad-name] [options]--dry-runValidate without actually publishing--strictFail if validation status is not SAFE--price <cents>Set price in cents (e.g., 2990 for $29.90, 0 for free)Multi-select from local squads
squads publishPublish a squad by name
squads publish my-squadPublish from a specific path
squads publish ./squads/my-squadDry run to validate before publishing
squads publish --dry-runStrict mode (requires SAFE status)
squads publish my-squad --strictPublish with price ($29.90)
squads publish --price 2990Publish as free
squads publish --price 0squads login
Authenticate with squads.sh using GitHub device flow. Required before publishing squads.
squads loginAuthenticate via GitHub
squads login