Scripts Reference
Complete reference for all installation and utility scripts in Claude Craft.
Installation Scripts
All installation scripts are located in Dev/scripts/.
Common Options
All installation scripts support these options:
| Option | Description |
|---|---|
--install | Fresh installation (default) |
--update | Update existing files only |
--force | Overwrite all files |
--preserve-config | Keep CLAUDE.md and project context |
--dry-run | Simulate without changes |
--backup | Create backup before changes |
--interactive | Guided installation |
--verbose | Show detailed output |
--lang=XX | Set language (en, fr, es, de, pt) |
--agents-only | Install only agents |
--commands-only | Install only commands |
--rules-only | Install only rules |
--templates-only | Install only templates |
--checklists-only | Install only checklists |
Technology Installation Scripts
install-common-rules.sh
Installs common/transversal rules, agents, and commands.
./Dev/scripts/install-common-rules.sh [options] <target>
# Examples
./Dev/scripts/install-common-rules.sh ~/my-project
./Dev/scripts/install-common-rules.sh --lang=fr ~/my-project
./Dev/scripts/install-common-rules.sh --force --backup ~/my-projectInstalls:
- Common agents (api-designer, database-architect, tdd-coach, etc.)
- Common commands (
/common:*) - Base references (SOLID, KISS/DRY/YAGNI, Git workflow)
- Skills (testing, security, documentation)
install-symfony-rules.sh
Installs Symfony/PHP rules and tooling.
./Dev/scripts/install-symfony-rules.sh [options] <target>
# Examples
./Dev/scripts/install-symfony-rules.sh ~/my-project
./Dev/scripts/install-symfony-rules.sh --lang=fr --force ~/my-projectInstalls:
- Symfony-specific references (architecture, DDD, testing)
- Symfony reviewer agent
- Symfony commands (
/symfony:*) - PHP templates
install-flutter-rules.sh
Installs Flutter/Dart rules and tooling.
./Dev/scripts/install-flutter-rules.sh [options] <target>
# Examples
./Dev/scripts/install-flutter-rules.sh ~/my-app
./Dev/scripts/install-flutter-rules.sh --lang=de ~/my-appInstalls:
- Flutter-specific references (BLoC, Riverpod, Material)
- Flutter reviewer agent
- Flutter commands (
/flutter:*) - Dart templates
install-react-rules.sh
Installs React/TypeScript rules and tooling.
./Dev/scripts/install-react-rules.sh [options] <target>Installs:
- React references (hooks, state management, a11y)
- React reviewer agent
- React commands (
/react:*) - TypeScript templates
install-reactnative-rules.sh
Installs React Native rules and tooling.
./Dev/scripts/install-reactnative-rules.sh [options] <target>Installs:
- React Native references (navigation, native modules)
- React Native reviewer agent
- React Native commands (
/reactnative:*)
install-python-rules.sh
Installs Python rules and tooling.
./Dev/scripts/install-python-rules.sh [options] <target>Installs:
- Python references (FastAPI, async, typing)
- Python reviewer agent
- Python commands (
/python:*)
install-angular-rules.sh
Installs Angular rules and tooling.
./Dev/scripts/install-angular-rules.sh [options] <target>Installs:
- Angular references (signals, standalone, RxJS)
- Angular reviewer agent
- Angular commands (
/angular:*)
install-csharp-rules.sh
Installs C#/.NET rules and tooling.
./Dev/scripts/install-csharp-rules.sh [options] <target>Installs:
- C# references (Clean Architecture, CQRS, EF Core)
- C# reviewer agent
- C# commands (
/csharp:*) - C# templates
install-laravel-rules.sh
Installs Laravel rules and tooling.
./Dev/scripts/install-laravel-rules.sh [options] <target>Installs:
- Laravel references (Actions, Pest PHP, Sanctum)
- Laravel reviewer agent
- Laravel commands (
/laravel:*)
install-vuejs-rules.sh
Installs Vue.js rules and tooling.
./Dev/scripts/install-vuejs-rules.sh [options] <target>Installs:
- Vue.js references (Composition API, Pinia)
- Vue.js reviewer agent
- Vue.js commands (
/vuejs:*)
install-php-rules.sh
Installs PHP (non-framework) rules and tooling.
./Dev/scripts/install-php-rules.sh [options] <target>Installs:
- PHP references (PSR-12, PHPStan)
- PHP reviewer agent
- PHP commands (
/php:*)
Configuration Scripts
install-from-config.sh
Installs from YAML configuration file.
./Dev/scripts/install-from-config.sh [options] <config-file> [project-name]
# Examples
./Dev/scripts/install-from-config.sh claude-projects.yaml
./Dev/scripts/install-from-config.sh claude-projects.yaml my-project
./Dev/scripts/install-from-config.sh --dry-run claude-projects.yamlOptions:
--dry-run- Preview changes--all- Install all projects in config
check-config.sh
Validates YAML configuration file.
./Dev/scripts/check-config.sh <config-file>
# Example
./Dev/scripts/check-config.sh claude-projects.yamlValidates:
- YAML syntax
- Required fields (name, root, modules)
- Valid technology names
- Path existence
Utility Scripts
check-prerequisites.sh
Checks if all prerequisites are installed.
./Dev/scripts/check-prerequisites.sh [options]
# Examples
./Dev/scripts/check-prerequisites.sh
./Dev/scripts/check-prerequisites.sh --verbose
./Dev/scripts/check-prerequisites.sh --fixOptions:
--verbose- Show version details--fix- Show installation commands
Checks:
- Node.js (18+)
- npm
- yq (v4, Mike Farah's version)
- Git
- Docker (optional)
- jq (optional)
- make (optional)
tcl-common.sh
Common functions used by installation scripts.
Not meant to be run directly. Sourced by other scripts.
Provides:
create_tcl_structure()- Creates TCL directoriescopy_references()- Copies reference filesgenerate_claude_md()- Generates CLAUDE.mdgenerate_index_md()- Generates INDEX.mdbackup_existing()- Creates backuplog_info(),log_error()- Logging functions
Infrastructure Scripts
Located in Infra/.
install-docker-rules.sh
Installs Docker/infrastructure rules and agents.
./Infra/install-docker-rules.sh [options] <target>
# Examples
./Infra/install-docker-rules.sh ~/my-project
./Infra/install-docker-rules.sh --lang=fr ~/my-projectInstalls:
- Docker agents (dockerfile, compose, debug, cicd, architect)
- Docker commands (
/docker:*)
Project Scripts
Located in Project/.
install-project-commands.sh
Installs project management commands.
./Project/install-project-commands.sh [options] <target>
# Examples
./Project/install-project-commands.sh ~/my-project
./Project/install-project-commands.sh --lang=fr ~/my-projectInstalls:
- Project commands (
/project:*) - Sprint commands (
/sprint:*) - Gate commands (
/gate:*) - BMAD agents and commands
- Product Owner and Tech Lead agents
Tool Scripts
Located in Tools/.
StatusLine Installation
./Tools/StatusLine/install.sh
# Or via make
make install-statuslineInstalls custom status line for Claude Code.
MultiAccount Installation
./Tools/MultiAccount/install.sh
# Or via make
make install-multiaccountInstalls multi-account manager for Claude Code.
ProjectConfig Installation
./Tools/ProjectConfig/install.sh
# Or via make
make install-projectconfigInstalls interactive project configuration manager.
RTK Installation
./Tools/RTK/install-rtk.sh --lang=en
# Or via make
make install-rtk
# Check status
./Tools/RTK/install-rtk.sh --check
# Uninstall
./Tools/RTK/install-rtk.sh --uninstallInstalls RTK (Rust Token Killer) for LLM token optimization. Configures PreToolUse hook in ~/.claude/settings.json.
Environment Variables
Scripts respect these environment variables:
| Variable | Description | Default |
|---|---|---|
CLAUDE_CRAFT_LANG | Default language | en |
CLAUDE_CRAFT_ROOT | Claude Craft installation | $(dirname $0)/.. |
VERBOSE | Enable verbose output | 0 |
DRY_RUN | Enable dry run | 0 |
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Invalid arguments |
| 3 | Missing prerequisites |
| 4 | Target not found |
| 5 | Permission denied |
| 6 | Backup failed |
| 7 | Migration failed |
Examples
Fresh Installation
# Full installation with French
./Dev/scripts/install-symfony-rules.sh --lang=fr ~/my-project
./Dev/scripts/install-common-rules.sh --lang=fr ~/my-projectUpdate Existing
# Update without overwriting customizations
./Dev/scripts/install-symfony-rules.sh --update ~/my-projectForce Reinstall
# Force reinstall with backup
./Dev/scripts/install-symfony-rules.sh --force --backup ~/my-projectPartial Installation
# Install only agents
./Dev/scripts/install-symfony-rules.sh --agents-only ~/my-project
# Install only commands
./Dev/scripts/install-symfony-rules.sh --commands-only ~/my-projectDry Run
# Preview what would be installed
./Dev/scripts/install-symfony-rules.sh --dry-run ~/my-project