module
Shards::Docs::CLIReference
Overview
CLI Commands Reference
Core commands
| Command | Description |
|---|---|
| shards install | Install dependencies from shard.yml |
| shards update [names...] | Update dependencies to latest compatible |
| shards build [targets...] | Build targets defined in shard.yml |
| shards run [target] | Build and run a target |
| shards check | Verify all dependencies are installed |
| shards list [--tree] | List installed dependencies |
| shards lock [--update] | Lock dependencies without installing |
| shards outdated [--pre] | Show outdated dependencies |
| shards prune | Remove unused dependencies |
| shards version [path] | Print the shard version |
| shards init | Generate a new shard.yml |
AI docs commands
| Command | Description |
|---|---|
| shards ai-docs | Show installed AI docs status |
| shards ai-docs diff <shard> | Diff local changes vs upstream |
| shards ai-docs reset <shard> [file] | Reset to upstream version |
| shards ai-docs update [shard] | Force re-install AI docs |
| shards ai-docs merge-mcp | Merge shard MCP configs into .mcp.json |
| shards run-script [names...] | Run pending postinstall scripts |
| shards docs [options] | Generate themed docs with AI buttons |
| shards sbom [options] | Generate SBOM (SPDX/CycloneDX) |
MCP lifecycle commands
| Command | Description |
|---|---|
| shards mcp | Show MCP server status (default) |
| shards mcp start [name] | Start all or one MCP server |
| shards mcp stop [name] | Stop all or one MCP server |
| shards mcp restart [name] | Restart all or one MCP server |
| shards mcp logs <name> | Tail server logs (--no-follow, --lines=N) |
Global flags
| Flag | Description |
|---|---|
| --frozen | Strictly install locked versions |
| --without-development | Skip dev dependencies |
| --production | --frozen --without-development |
| --skip-postinstall | Skip postinstall scripts |
| --skip-executables | Skip executable installation |
| --skip-ai-docs | Skip AI documentation installation |
| --local | Use local cache only |
| --jobs=N | Parallel downloads (default: 8) |
See individual command classes in Commands.