CLI Documentation

The SnapBack CLI tool provides powerful automation and scripting capabilities for integrating SnapBack into your development workflow.

Installation

Install the SnapBack CLI globally using npm:

Copynpm install -g @snapback/cli

Or using yarn:

Copyyarn global add @snapback/cli

Verify the installation:

Copysnapback --version

Authentication

Before using the CLI, you’ll need to authenticate:

Copy# Login with your SnapBack account
snapback auth login

# Or use an API key
snapback auth login --api-key YOUR_API_KEY

Core Commands

Snapshot Management

Create Snapshots

Copy# Create a snapshot of a specific file
snapback snapshot create --file src/index.js

# Create snapshots for all files matching a pattern
snapback snapshot create --pattern "src/**/*.js"

# Create snapshots for the entire project
snapback snapshot create --all

List Snapshots

Copy# List all snapshots
snapback snapshot list

# List snapshots for a specific file
snapback snapshot list --file src/index.js

# List snapshots with pagination
snapback snapshot list --limit 50 --offset 100

Restore Snapshots

Copy# Restore a specific snapshot
snapback snapshot restore --id snapshot_12345

# Restore the latest snapshot of a file
snapback snapshot restore --file src/index.js --latest

# Preview changes before restoring
snapback snapshot restore --id snapshot_12345 --dry-run

Session Management

Create and Manage Sessions

Copy# Create a new session
snapback session create --name "Implement authentication"

# End the current session
snapback session end

# List all sessions
snapback session list

# View session details
snapback session view --id session_12345

# Restore an entire session
snapback session restore --id session_12345

Session Comparison

Copy# Compare two sessions
snapback session diff --id session_12345 --id session_67890

# Export comparison as HTML
snapback session diff --id session_12345 --id session_67890 --format html > comparison.html

Protection Management

Set Protection Levels

Copy# Set protection level for a file
snapback protect --file src/config.js --level warn

# Set protection level for files matching a pattern
snapback protect --pattern "**/*.env" --level block

# List current protection rules
snapback protect list

AI Detection

Scan for Risks

Copy# Scan a specific file
snapback scan --file src/index.js

# Scan the entire project
snapback scan --all

# Scan with specific sensitivity
snapback scan --all --sensitivity high

Manage False Positives

Copy# Ignore a specific pattern
snapback ignore add "**/mock-data/**"

# List ignored patterns
snapback ignore list

# Remove an ignored pattern
snapback ignore remove "**/mock-data/**"

Configuration

Configuration File

Create a .snapbackconfig file in your project root:

Copy{
  "storage": {
    "path": "./.snapback",
    "maxSnapshotsPerFile": 100
  },
  "aiDetection": {
    "sensitivity": "high",
    "ignorePatterns": [
      "**/*.test.js",
      "**/mocks/**"
    ]
  },
  "protection": {
    "defaultLevel": "warn",
    "rules": [
      {
        "pattern": "**/.env*",
        "level": "block"
      },
      {
        "pattern": "docs/**",
        "level": "watch"
      }
    ]
  }
}

Environment Variables

Set environment variables for CLI configuration:

Copy# Set API key
export SNAPBACK_API_KEY=your_api_key_here

# Set storage path
export SNAPBACK_STORAGE_PATH=/custom/storage/path

# Set log level
export SNAPBACK_LOG_LEVEL=debug

Automation Examples

Continuous Integration

Add SnapBack to your CI pipeline:

Copy# .github/workflows/snapback.yml
name: SnapBack Analysis
on: [push, pull_request]
jobs:
  snapback-scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '16'
      - name: Install SnapBack CLI
        run: npm install -g @snapback/cli
      - name: Scan for AI risks
        run: snapback scan --all --format json > scan-results.json
      - name: Upload results
        uses: actions/upload-artifact@v2
        with:
          name: snapback-scan-results
          path: scan-results.json

Pre-commit Hook

Prevent risky commits with a pre-commit hook:

Copy#!/bin/bash
# .git/hooks/pre-commit

# Scan staged files for AI risks
snapback scan --staged

# If risks are found, prevent commit
if [ $? -ne 0 ]; then
  echo "⚠️  SnapBack detected potential risks. Please review before committing."
  exit 1
fi

echo "✅ No risks detected by SnapBack"
exit 0

Backup Script

Automate regular backups:

Copy#!/bin/bash
# backup.sh

# Create snapshots for all files
snapback snapshot create --all

# Clean up old snapshots (keep last 30 days)
snapback cleanup --keep 30d

# Export snapshot data
snapback export --output snapshots-$(date +%Y%m%d).json

echo "Backup completed: $(date)"

Advanced Usage

Custom Scripts

Create custom automation scripts:

Copy// snapback-automation.js
const { SnapBack } = require('@snapback/cli');

async function main() {
  const snapback = new SnapBack({
    apiKey: process.env.SNAPBACK_API_KEY
  });

  // Create snapshots for all JavaScript files
  await snapback.snapshot.create({
    pattern: '**/*.js'
  });

  // Scan for AI risks
  const results = await snapback.scan({
    all: true,
    sensitivity: 'high'
  });

  // Report findings
  if (results.risks.length > 0) {
    console.log(`⚠️  Found ${results.risks.length} potential risks:`);
    results.risks.forEach(risk => {
      console.log(`  - ${risk.file}:${risk.line} - ${risk.type}`);
    });
  } else {
    console.log('✅ No risks detected');
  }
}

main().catch(console.error);

Integration with Other Tools

Integrate SnapBack with other development tools:

Copy# Use with lint-staged
npx lint-staged

# Then run SnapBack scan
snapback scan --staged

Best Practices

Troubleshooting

Common Issues

1. Command not found: Ensure the CLI is installed globally and in your PATH
2. Authentication errors: Verify your API key and network connectivity
3. Permission denied: Check that you have write permissions to the storage directory

Getting Help

Copy# Get help for any command
snapback --help
snapback snapshot --help
snapback session --help

# Enable debug logging
snapback --log-level debug snapshot create --file src/index.js

Related Documentation

• Quick Start Guide - Get up and running quickly
• Protection Levels - Configure file protection
• AI Detection - Understand risk analysis
• Session Time-Travel - Navigate your coding history