Package Exports
- @scaffit/cli
Readme
@scaffit/cli
Command-line interface for Scaffit - Add modular scaffolds to your project.
Installation
npm install -g @scaffit/cliUsage
# Initialize new project with wizard
scaffit init
# Add scaffolds to your project
scaffit add env
scaffit add prettier
scaffit add stripe --dry-run # Preview changes
# Launch web dashboard
scaffit web
# Search and discover scaffolds
scaffit search payment
scaffit search --category auth
# List available scaffolds
scaffit list
# Check project health
scaffit health
# Update scaffolds
scaffit update nextauth
scaffit update --all
# Rollback changes
scaffit rollback stripe
# Security audit
scaffit audit
# Test scaffolds
scaffit test env
scaffit test --all
# Diagnose and fix issues
scaffit repair
scaffit repair --all
# Clean up files and cache
scaffit clean --all
scaffit clean --cache
# Validate project integrity
scaffit validate
scaffit validate --fix
# Get help and information
scaffit help
scaffit help add
scaffit info env
scaffit info --all
# Remove a scaffold
scaffit remove envCommands
scaffit init
Initialize a new project with interactive wizard:
- Framework selection (Next.js, React, Express, etc.)
- Package manager choice (npm, pnpm, yarn)
- Scaffold selection
- Git initialization
- One-command project creation
scaffit add <scaffold>
Add a scaffold to your current project:
- Load scaffold from npm
- Interactive configuration prompts
- Install files and dependencies
- Show summary of changes
--dry-runflag for preview mode
scaffit search <query>
Search and discover scaffolds:
- Fuzzy search by name, tags, category
- Popularity metrics and ratings
- Filter by framework compatibility
- Interactive installation
scaffit health
Check project health and diagnostics:
- Scaffold version checks
- Security vulnerability scanning
- Dependency analysis
- Configuration validation
- Best practice recommendations
scaffit update <scaffold>
Update scaffolds to latest versions:
- Version checking with changelog
- Breaking change warnings
- Automatic migration
- Batch updates with
--all --dry-runfor preview
scaffit rollback <scaffold>
Rollback scaffold changes:
- Version history tracking
- One-click rollback
- Automatic backups
- Git integration
scaffit audit
Security audit and compliance check:
- CVE database checking
- Dependency vulnerability scanning
- Hardcoded secret detection
- Configuration security analysis
- Fix recommendations
scaffit test <scaffold>
Test scaffold installations:
- Installation verification
- Runtime testing
- Integration testing
- Performance benchmarks
--allflag for all scaffolds
scaffit web
Launch the web dashboard for visual scaffold management.
scaffit list
List all available scaffolds, optionally filtered by category.
scaffit repair
Diagnose and fix common issues with scaffolds:
- Fixes corrupted scaffold installations
- Repairs missing files and dependencies
- Cleans up orphaned files
- Interactive or automatic fixing
scaffit clean
Clean up temporary files, cache, and backups:
- Cleans npm/pnpm/yarn cache
- Removes old scaffold backups
- Cleans temporary installation files
- Shows space freed after cleanup
scaffit validate
Validate project integrity and scaffold installations:
- Validates scaffold installations
- Checks file integrity and configuration
- Verifies dependencies and scripts
- Provides fix recommendations
scaffit help [command]
Show help information and command list:
- General help with all commands
- Specific command help with examples
- Usage patterns and options
- Support information
scaffit info [scaffold]
Show detailed information about scaffolds:
- Comprehensive scaffold details
- Dependencies and file structure
- Configuration options
- Usage examples and changelog
scaffit remove <scaffold>
Remove a previously installed scaffold.
Examples
# Initialize new project
scaffit init
# Add environment variable setup
scaffit add env
# Add Prettier formatting
scaffit add prettier
# Preview Stripe integration
scaffit add stripe --dry-run
# Launch web UI
scaffit web --port 3001
# Search for payment scaffolds
scaffit search payment
# List all scaffolds
scaffit list
# Check project health
scaffit health
# Update all scaffolds
scaffit update --all
# Rollback Stripe to previous version
scaffit rollback stripe
# Run security audit
scaffit audit
# Test all scaffolds
scaffit test --all
# Diagnose and fix issues
scaffit repair --all
# Clean up everything
scaffit clean --all
# Validate project
scaffit validate --fix
# Get help
scaffit help add
# Get scaffold information
scaffit info stripe
scaffit info --allConfiguration
Scaffolds are configured through interactive prompts. Each scaffold defines its own configuration schema.
Troubleshooting
- Scaffold not found: Make sure the scaffold name is correct and the package is published
- Permission errors: Ensure you have write permissions to the project directory
- Network issues: Check your internet connection for downloading packages