Terminal Setup Guide
Complete guide to using Bootspring from the command line without any IDE integration.
Overview#
Bootspring works great as a standalone CLI tool, independent of any AI assistant or IDE. Perfect for:
- Server environments
- CI/CD pipelines
- Quick project setup
- Automation scripts
- Developers who prefer terminal workflows
Prerequisites#
- Node.js 18+ installed
- npm or yarn
- Terminal (bash, zsh, fish, PowerShell)
Installation#
Global Install (Recommended)#
npm install -g @girardmedia/bootspringLocal Install#
npm install --save-dev @girardmedia/bootspring
npx bootspring --versionVerify Installation#
bootspring --version
bootspring doctorQuick Start#
Initialize a New Project#
mkdir my-project
cd my-project
npm init -y
bootspring initInitialize an Existing Project#
cd existing-project
bootspring onboardCore Workflows#
1. Project Setup#
1# Interactive initialization
2bootspring init
3
4# Generate context files
5bootspring generate
6
7# Check health
8bootspring health2. Development Loop#
1# Manage todos
2bootspring todo add "Build user authentication"
3bootspring todo list
4bootspring todo done 1
5
6# Run quality checks
7bootspring quality pre-commit
8
9# Check project health
10bootspring health3. Business Planning#
1# Generate business documents
2bootspring business init
3bootspring fundraise init
4bootspring legal init
5
6# Check status
7bootspring business status4. Analysis & Audit#
1# Analyze codebase
2bootspring analyze
3
4# Security and quality audit
5bootspring audit
6
7# View reports
8cat planning/CODEBASE_ANALYSIS.md
9cat planning/AUDIT_REPORT.md5. Deployment#
# Deploy to production
bootspring deploy vercel
# Monitor
bootspring monitor statusAgent Interaction (CLI)#
List Available Agents#
bootspring agent listInvoke an Agent#
1# Get security advice
2bootspring agent invoke security-expert "Review my authentication implementation"
3
4# Get database design help
5bootspring agent invoke database-expert "Design schema for e-commerce"
6
7# Get frontend guidance
8bootspring agent invoke frontend-expert "Best practices for React forms"Agent Output#
Agent responses are written to .bootspring/logs/ and displayed in the terminal.
Skill Patterns#
Browse Patterns#
1# List all patterns
2bootspring skill list
3
4# Search patterns
5bootspring skill search "authentication"
6
7# View a pattern
8bootspring skill show auth/jwtApply Patterns#
Patterns provide code snippets and implementation guidance:
1# View and copy pattern code
2bootspring skill show api/rest-endpoint
3
4# Categories
5bootspring skill list --category api
6bootspring skill list --category database
7bootspring skill list --category securityConfiguration#
Create Config File#
# Creates bootspring.config.js
bootspring initConfig Structure#
1// bootspring.config.js
2module.exports = {
3 project: {
4 name: 'my-project',
5 type: 'nextjs',
6 language: 'typescript'
7 },
8 context: {
9 include: ['src/**/*.ts'],
10 exclude: ['node_modules/**']
11 },
12 telemetry: {
13 enabled: true
14 }
15};Environment Variables#
1# API key for premium features
2export BOOTSPRING_API_KEY="bs_live_xxx"
3
4# Disable telemetry
5export BOOTSPRING_TELEMETRY=false
6
7# Set project directory
8export BOOTSPRING_PROJECT_DIR=/path/to/projectShell Completions#
Bash#
# Add to ~/.bashrc
eval "$(bootspring completions bash)"Zsh#
# Add to ~/.zshrc
eval "$(bootspring completions zsh)"Fish#
# Add to ~/.config/fish/config.fish
bootspring completions fish | sourceAutomation#
Git Hooks#
Pre-commit quality check:
#!/bin/sh
# .git/hooks/pre-commit
bootspring quality pre-commitPost-commit context update:
#!/bin/sh
# .git/hooks/post-commit
bootspring generate --quietCI/CD Integration#
GitHub Actions:
1name: Quality Check
2on: [push, pull_request]
3
4jobs:
5 quality:
6 runs-on: ubuntu-latest
7 steps:
8 - uses: actions/checkout@v4
9 - uses: actions/setup-node@v4
10 with:
11 node-version: '20'
12 - run: npm install -g @girardmedia/bootspring
13 - run: bootspring quality pre-deployScripting#
1#!/bin/bash
2# deploy.sh
3
4set -e
5
6echo "Running quality checks..."
7bootspring quality pre-deploy
8
9echo "Generating context..."
10bootspring generate
11
12echo "Deploying..."
13bootspring deploy vercel
14
15echo "Setting up monitoring..."
16bootspring monitor post-deployMulti-Project Workflows#
Workspace Setup#
1# Initialize workspace
2bootspring workspace init my-workspace
3
4# Add projects
5bootspring workspace add ../frontend --tags=frontend
6bootspring workspace add ../backend --tags=backend
7bootspring workspace add ../shared --tags=shared
8
9# List projects
10bootspring workspace listRun Across Projects#
1# Analyze all projects
2bootspring workspace run analyze
3
4# Audit only backend
5bootspring workspace run audit --filter=backend
6
7# Health check all
8bootspring workspace run healthAutonomous Workflows#
Loop Mode#
Run tasks autonomously:
1# Start autonomous loop
2bootspring loop start
3
4# With specific task source
5bootspring loop start --source todo.md
6
7# Resume session
8bootspring loop resumeOrchestrator#
Intelligent workflow coordination:
1# Start a workflow
2bootspring orchestrator start feature-development
3
4# Check status
5bootspring orchestrator status
6
7# Advance to next phase
8bootspring orchestrator nextOutput Formats#
JSON Output#
Many commands support --json for scripting:
bootspring health --json > health.json
bootspring workspace list --json | jq '.projects'
bootspring todo list --json | jq '.todos | length'Pipe to Other Tools#
1# Count todos
2bootspring todo list --json | jq '.todos | length'
3
4# Filter audit findings
5bootspring audit --json | jq '.findings[] | select(.severity == "high")'
6
7# Export workspace status
8bootspring workspace status --json | tee status.jsonTroubleshooting#
Common Issues#
Command not found:
# Check installation
which bootspring
# Reinstall globally
npm install -g @girardmedia/bootspringPermission errors:
# Fix npm permissions
sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}Node version:
1# Check version
2node --version
3
4# Use nvm to switch
5nvm install 20
6nvm use 20Diagnostics#
1# Full diagnostic
2bootspring doctor
3
4# Verbose output
5bootspring generate --verbose
6
7# Debug mode
8DEBUG=bootspring* bootspring analyzeBest Practices#
Project Structure#
my-project/
├── CLAUDE.md # Generated context
├── bootspring.config.js # Configuration
├── .bootspring/ # Local data
│ ├── workflows/
│ ├── logs/
│ └── cache/
├── planning/ # Generated reports
│ ├── CODEBASE_ANALYSIS.md
│ └── AUDIT_REPORT.md
└── todo.md # Task tracking
Daily Workflow#
-
Morning:
bootspring health bootspring todo list -
Development:
bootspring todo add "New feature" # ... work ... bootspring quality pre-commit -
End of day:
bootspring generate git commit -am "Progress"