This document provides a comprehensive reference for all Syncable CLI commands, options, and workflows.
- Global Options
- Commands
- analyze - Project analysis
- generate - IaC generation
- validate - IaC validation (planned)
- support - Show supported tech
- dependencies - Dependency analysis
- vulnerabilities - CVE scanning
- security - Comprehensive security scan
- tools - Tool management
- chat - AI assistant
- auth - Authentication
- Configuration
- Common Workflows
- VS Code Integration
- Environment Variables
- Exit Codes
Available for all commands:
| Flag | Short | Description |
|---|---|---|
--config <FILE> |
-c |
Path to configuration file |
--verbose |
-v |
Enable verbose logging (-v info, -vv debug, -vvv trace) |
--quiet |
-q |
Suppress all output except errors |
--json |
Output in JSON format where applicable | |
--clear-update-cache |
Clear update check cache and force a new check | |
--disable-telemetry |
Disable telemetry data collection | |
--help |
-h |
Show help information |
--version |
-V |
Show version information |
Analyze a project and display detected components (languages, frameworks, dependencies, architecture).
Arguments:
<PROJECT_PATH>— Path to the project directory to analyze
Options:
| Flag | Short | Description |
|---|---|---|
--json |
-j |
Output analysis results in JSON format |
--detailed |
-d |
Show detailed analysis information (legacy format) |
--display <FORMAT> |
Display format: matrix (default), detailed, summary |
|
--only <ASPECTS> |
Only analyze specific aspects (comma-separated: languages, frameworks, dependencies) | |
--color-scheme <SCHEME> |
Color scheme: auto (default), dark, light |
Display Mode Comparison:
- Best for: Quick overview, comparing multiple projects
- Features: Modern dashboard with box-drawing characters, side-by-side project comparison, key metrics
- Docker Info: Overview with service counts and orchestration patterns
- Best for: In-depth analysis, debugging, comprehensive reports
- Features: Full Docker analysis, complete technology breakdown, all metadata
- Docker Info: Complete Docker infrastructure analysis including:
- Dockerfile analysis with base images, ports, stages
- Docker Compose services with dependencies and networking
- Orchestration patterns and service discovery
- Port mappings and volume configurations
- Best for: CI/CD pipelines, quick status checks
- Features: Brief overview with essential information only
Examples:
# Basic analysis with modern matrix view
sync-ctl analyze .
# Detailed view with full Docker analysis
sync-ctl analyze . --display detailed
# Or use the legacy flag
sync-ctl analyze . -d
# Summary view for CI/CD pipelines
sync-ctl analyze . --display summary
# JSON output for scripting
sync-ctl analyze . --json
# Only show languages and frameworks
sync-ctl analyze . --only languages,frameworks
# Use light terminal theme colors
sync-ctl analyze . --color-scheme light
# Analyze specific project path
sync-ctl analyze /path/to/projectSupported Technologies:
- Languages: Rust, JavaScript/TypeScript, Python, Go, Java
- Frameworks: 260+ including React, Vue, Angular, Next.js, Express, Django, Flask, FastAPI, Spring Boot, and more
- Databases: PostgreSQL, MySQL, MongoDB, Redis, and more
- Tools: Docker, Kubernetes, Terraform, and more
Generate Infrastructure as Code files (Dockerfile, docker-compose.yml, Terraform config).
Arguments:
<PROJECT_PATH>— Path to the project directory
Options:
| Flag | Short | Description |
|---|---|---|
--output <OUTPUT_DIR> |
-o |
Output directory for generated files |
--dockerfile |
Generate Dockerfile | |
--compose |
Generate Docker Compose file | |
--terraform |
Generate Terraform configuration | |
--all |
Generate all supported IaC files (default if no specific flag) | |
--dry-run |
Preview output without creating files | |
--force |
Overwrite existing files |
Examples:
# Generate all IaC files
sync-ctl generate .
sync-ctl generate . --all
# Only generate Dockerfile
sync-ctl generate . --dockerfile
# Generate Dockerfile and Compose
sync-ctl generate . --dockerfile --compose
# Preview without creating files
sync-ctl generate . --dry-run
# Custom output directory
sync-ctl generate . --output ./infrastructure/
# Generate and overwrite existing files
sync-ctl generate . --all --forceStatus: 🚧 In Development
- Basic generation implemented
- Enhanced monorepo generation with per-project IaC files coming soon
Validate existing IaC files against best practices.
Arguments:
<PATH>— Path to directory containing IaC files
Options:
| Flag | Description |
|---|---|
--types <TYPES> |
Types of files to validate (comma-separated) |
--fix |
Automatically fix issues where possible |
Examples:
# Validate all IaC files
sync-ctl validate .
# Validate specific types
sync-ctl validate . --types dockerfile,compose
# Auto-fix issues
sync-ctl validate . --fixStatus:
Show supported languages and frameworks.
Options:
| Flag | Short | Description |
|---|---|---|
--languages |
Show only languages | |
--frameworks |
Show only frameworks | |
--detailed |
-d |
Show detailed information |
Examples:
# Show all supported tech
sync-ctl support
# Only show languages
sync-ctl support --languages
# Only show frameworks
sync-ctl support --frameworks
# Detailed information
sync-ctl support --detailedSupported Technologies:
260+ technologies across 5 ecosystems
JavaScript/TypeScript — React, Vue, Angular, Next.js, Express, Nest.js, Fastify, and 40+ more
Python — Django, Flask, FastAPI, Celery, NumPy, TensorFlow, PyTorch, and 70+ more
Go — Gin, Echo, Fiber, gRPC, Kubernetes client, and 20+ more
Rust — Actix-web, Axum, Rocket, Tokio, SeaORM, and 20+ more
Java/Kotlin — Spring Boot, Micronaut, Quarkus, Hibernate, and 90+ more
Analyze project dependencies in detail.
Arguments:
<PROJECT_PATH>— Path to the project directory
Options:
| Flag | Description |
|---|---|
--licenses |
Show license information for dependencies |
--vulnerabilities |
Check for known vulnerabilities |
--prod-only |
Show only production dependencies |
--dev-only |
Show only development dependencies |
--format <FORMAT> |
Output format: table (default) or json |
Examples:
# Show all dependencies
sync-ctl dependencies .
# Analyze with licenses
sync-ctl dependencies . --licenses
# Check for vulnerabilities
sync-ctl dependencies . --vulnerabilities
# Show only production dependencies with licenses
sync-ctl dependencies . --prod-only --licenses
# Development dependencies only
sync-ctl dependencies . --dev-only
# JSON output
sync-ctl dependencies . --format json
sync-ctl dependencies . --vulnerabilities --format json > deps.jsonSupported Package Managers:
- npm, yarn, pnpm, bun (JavaScript)
- pip, pipenv, poetry (Python)
- cargo (Rust)
- go.mod (Go)
- maven, gradle (Java)
Check dependencies for known security vulnerabilities (CVEs).
Arguments:
[PATH]— Path to scan (default: current directory.)
Options:
| Flag | Description |
|---|---|
--severity <LEVEL> |
Show only vulnerabilities with severity >= threshold (low, medium, high, critical) |
--format <FORMAT> |
Output format: table (default) or json |
--output <FILE> |
Export report to file |
Examples:
# Scan current directory
sync-ctl vulnerabilities
sync-ctl vulnerabilities .
# Only show high and critical vulnerabilities
sync-ctl vulnerabilities . --severity high
sync-ctl vulnerabilities . --severity critical
# Only show critical vulnerabilities
sync-ctl vulnerabilities . --severity critical
# Export report to file (table format)
sync-ctl vulnerabilities . --output report.txt
# Export JSON report
sync-ctl vulnerabilities . --output report.json --format json
# Scan specific path with severity filter
sync-ctl vulnerabilities /path/to/project --severity mediumSupported Package Managers:
- npm, yarn, pnpm, bun (JavaScript)
- pip (Python)
- cargo (Rust)
- go mod (Go)
- maven, gradle (Java)
Exit Behavior:
- Exits with code
1if critical or high severity vulnerabilities are found - Use this in CI/CD to fail builds on security issues
Perform comprehensive security analysis (secrets detection, code patterns, vulnerabilities).
Arguments:
[PROJECT_PATH]— Path to analyze (default: current directory.)
Options:
| Flag | Description |
|---|---|
--mode <MODE> |
Scan mode: lightning, fast, balanced, thorough (default), paranoid |
--include-low |
Include low severity findings |
--no-secrets |
Skip secrets detection |
--no-code-patterns |
Skip code pattern analysis |
--format <FORMAT> |
Output format: table (default) or json |
--output <FILE> |
Export report to file |
--fail-on-findings |
Exit with error code on security findings |
Security Scan Modes:
| Mode | Speed | Coverage | Use Case |
|---|---|---|---|
lightning |
🚀 Fastest | Critical files only | Pre-commit hooks, CI checks |
fast |
⚡ Very Fast | Smart sampling | Development workflow |
balanced |
🎯 Optimized | Good coverage | Regular security checks |
thorough |
🔍 Complete | Comprehensive | Security audits (default) |
paranoid |
🕵️ Maximum | Everything + low severity | Compliance, releases |
Examples:
# Comprehensive security scan (default: thorough mode)
sync-ctl security
sync-ctl security .
# Lightning-fast scan for pre-commit hooks
sync-ctl security --mode lightning
sync-ctl security . --mode lightning
# Fast scan for development
sync-ctl security . --mode fast
# Balanced scan (recommended for regular checks)
sync-ctl security . --mode balanced
# Paranoid scan with low severity findings
sync-ctl security . --mode paranoid
sync-ctl security . --mode paranoid --include-low
# Skip specific checks
sync-ctl security . --no-secrets
sync-ctl security . --no-code-patterns
sync-ctl security . --no-secrets --no-code-patterns
# Export security report
sync-ctl security . --output security-report.txt
sync-ctl security . --output security-report.json --format json
# Fail CI/CD on security findings
sync-ctl security . --fail-on-findings
sync-ctl security . --mode fast --fail-on-findings --format jsonWhat It Detects:
- Secrets: API keys, tokens, passwords, credentials
- Code Patterns: SQL injection, XSS, insecure crypto, hardcoded secrets
- Vulnerabilities: Known CVEs in dependencies
- Security Best Practices: File permissions, configuration issues
Performance:
- Powered by Turbo Engine (10-100x faster than traditional scanners)
- Uses parallel processing and smart caching
- Blazing-fast secret detection powered by Rust
Manage vulnerability scanning tools (install, check status, verify).
Check which vulnerability scanning tools are installed.
Options:
| Flag | Description |
|---|---|
--format <FORMAT> |
Output format: table (default) or json |
--languages <LANGS> |
Check tools for specific languages only (comma-separated) |
Examples:
# Check all tools
sync-ctl tools status
# Check JavaScript tools only
sync-ctl tools status --languages javascript
# Check multiple languages
sync-ctl tools status --languages rust,python,javascript
# JSON output
sync-ctl tools status --format jsonInstall missing vulnerability scanning tools.
Options:
| Flag | Short | Description |
|---|---|---|
--languages <LANGS> |
Install tools for specific languages only (comma-separated) | |
--include-owasp |
Also install OWASP Dependency Check (large download) | |
--dry-run |
Show what would be installed without installing | |
--yes |
-y |
Skip confirmation prompts |
Examples:
# Install all missing tools (interactive)
sync-ctl tools install
# Install JavaScript tools only
sync-ctl tools install --languages javascript
# Install multiple language tools
sync-ctl tools install --languages rust,python
# Include OWASP Dependency Check (large download)
sync-ctl tools install --include-owasp
# Dry run to see what would be installed
sync-ctl tools install --dry-run
# Install without prompts
sync-ctl tools install --yes
sync-ctl tools install -yVerify that installed tools are working correctly.
Options:
| Flag | Short | Description |
|---|---|---|
--languages <LANGS> |
Test tools for specific languages only | |
--detailed |
-d |
Show detailed verification output |
Examples:
# Verify all tools
sync-ctl tools verify
# Verify specific language tools
sync-ctl tools verify --languages javascript
# Verify with detailed output
sync-ctl tools verify --detailed
sync-ctl tools verify -dShow tool installation guides for manual setup.
Options:
| Flag | Description |
|---|---|
--languages <LANGS> |
Show guide for specific languages only |
--platform <PLATFORM> |
Show platform-specific instructions |
Examples:
# Show all installation guides
sync-ctl tools guide
# Show Python tools guide
sync-ctl tools guide --languages python
# Platform-specific guide
sync-ctl tools guide --platform macos
sync-ctl tools guide --platform linux
sync-ctl tools guide --platform windowsSupported Tools:
- JavaScript: npm audit, yarn audit, pnpm audit, retire.js
- Python: pip-audit, safety
- Rust: cargo-audit
- Go: nancy
- Java: OWASP Dependency Check
Start an interactive AI chat session to analyze, generate, and understand your project.
Arguments:
[PROJECT_PATH]— Path to the project directory (default: current directory.)
Options:
| Flag | Short | Description |
|---|---|---|
--provider <PROVIDER> |
LLM provider: openai, anthropic, bedrock, ollama, auto (default) |
|
--model <MODEL> |
Model to use (e.g., gpt-4o, claude-3-5-sonnet-latest, llama3.2) |
|
--query <QUERY> |
Run a single query instead of interactive mode | |
--resume <SESSION> |
-r |
Resume a previous session (latest, session number, or UUID) |
--list-sessions |
List available sessions for this project and exit |
Examples:
# Start interactive chat (auto-detect provider)
sync-ctl chat
sync-ctl chat .
# Use specific provider
sync-ctl chat --provider openai
sync-ctl chat --provider anthropic
sync-ctl chat --provider bedrock
sync-ctl chat --provider ollama
# Use specific model
sync-ctl chat --model gpt-4o
sync-ctl chat --model claude-3-5-sonnet-latest
sync-ctl chat --model llama3.2
# Run a single query
sync-ctl chat --query "Generate a Dockerfile for this project"
sync-ctl chat --query "What security issues are in my code?"
sync-ctl chat --query "Optimize my Docker Compose file"
# Resume latest session
sync-ctl chat --resume latest
sync-ctl chat -r latest
# Resume specific session (by number)
sync-ctl chat --resume 3
sync-ctl chat -r 3
# Resume by UUID
sync-ctl chat --resume 8f7a9b2c
# List all sessions
sync-ctl chat --list-sessions
# Analyze specific project path
sync-ctl chat /path/to/projectChat Commands (inside interactive session):
| Command | Description |
|---|---|
/model |
Switch AI model (GPT-4, Claude, etc.) |
/provider |
Switch between OpenAI and Anthropic |
/clear |
Clear conversation history |
/help |
Show available commands |
Keyboard Shortcuts:
| Shortcut | Action |
|---|---|
Ctrl+J |
Insert newline (multi-line input) |
Shift+Enter |
Insert newline |
@filename |
Add file to context |
Ctrl+C |
Cancel / Exit |
Supported Providers:
| Provider | Models | API Key Required |
|---|---|---|
| OpenAI | GPT-4o, GPT-4, GPT-3.5 | Yes (OPENAI_API_KEY) |
| Anthropic | Claude 3 (Sonnet, Opus, Haiku) | Yes (ANTHROPIC_API_KEY) |
| Bedrock | Claude via AWS | Yes (AWS credentials) |
| Ollama | Llama 3.2, Mistral, etc. | No (local) |
Setup:
# OpenAI
export OPENAI_API_KEY="sk-..."
# Anthropic
export ANTHROPIC_API_KEY="sk-ant-..."
# Ollama (no key needed, install Ollama first)
# Download from https://ollama.aiWhat the Agent Can Do:
- Generate Dockerfiles, Docker Compose, Kubernetes manifests, Terraform configs
- Analyze your codebase and detect 260+ technologies
- Security scanning and vulnerability detection
- Create CI/CD pipelines (GitHub Actions, GitLab CI)
- Answer questions about your project structure
- Suggest optimizations and best practices
Authenticate with the Syncable platform.
Log in to Syncable (opens browser for authentication).
Options:
| Flag | Description |
|---|---|
--no-browser |
Don't open browser automatically |
Examples:
# Login (opens browser)
sync-ctl auth login
# Login without auto-opening browser
sync-ctl auth login --no-browserLog out and clear stored credentials.
Examples:
sync-ctl auth logoutShow current authentication status.
Examples:
sync-ctl auth statusPrint current access token (for scripting).
Options:
| Flag | Description |
|---|---|
--raw |
Print raw token without formatting |
Examples:
# Show formatted token
sync-ctl auth token
# Raw token for scripting
sync-ctl auth token --raw
# Use in API calls
curl -H "Authorization: Bearer $(sync-ctl auth token --raw)" https://api.syncable.dev/Place in your project root or ~/.config/syncable/config.toml:
[agent]
default_provider = "anthropic"
default_model = "claude-sonnet-4-20250514"
[security]
default_mode = "thorough"
fail_on_high_severity = true
[analysis]
ignore_patterns = ["node_modules", "target", "dist", ".git"]
[telemetry]
enabled = trueConfiguration Options:
default_provider— Default LLM provider (openai,anthropic,bedrock,ollama)default_model— Default model name (e.g.,gpt-4o,claude-3-5-sonnet-latest)
default_mode— Default security scan mode (lightning,fast,balanced,thorough,paranoid)fail_on_high_severity— Exit with error on high severity findings (boolean)
ignore_patterns— Patterns to ignore during analysis (array of strings)
enabled— Enable/disable telemetry (boolean)
# 1. Quick overview
sync-ctl analyze .
# 2. Detailed analysis with Docker
sync-ctl analyze . --display detailed
# 3. Security scan
sync-ctl security .
# 4. Vulnerability check
sync-ctl vulnerabilities . --severity medium
# 5. Generate IaC
sync-ctl generate . --all# Quick check for CI/CD
sync-ctl analyze . --display summary
# Security scan that fails on findings
sync-ctl security . --mode fast --fail-on-findings
# Vulnerability scan with threshold (fails on critical/high)
sync-ctl vulnerabilities . --severity high
# JSON reports for processing
sync-ctl dependencies . --vulnerabilities --format json > deps.json
sync-ctl security . --format json --output security.json# Analyze entire monorepo
sync-ctl analyze .
# Matrix view shows all projects side-by-side
sync-ctl analyze . --display matrix
# Individual project analysis
cd frontend && sync-ctl analyze . --display detailed
cd ../backend && sync-ctl analyze . --display detailed
# Security scan across entire monorepo
sync-ctl security . --mode thorough# Comprehensive security analysis
sync-ctl security . --mode paranoid --include-low
# Check vulnerabilities
sync-ctl vulnerabilities . --severity low
# Export reports
sync-ctl security . --output security-report.json --format json
sync-ctl vulnerabilities . --output vuln-report.json --format json
# Fail on findings (for compliance)
sync-ctl security . --fail-on-findings# Quick analysis before commit
sync-ctl analyze . --display summary
# Fast security scan
sync-ctl security . --mode lightning
# Generate Dockerfile for new service
sync-ctl generate . --dockerfile
# Ask AI for help
sync-ctl chat --query "How do I optimize this Dockerfile?"# .git/hooks/pre-commit
#!/bin/bash
sync-ctl security . --mode lightning --fail-on-findingsInstall the Syncable IDE Companion extension for enhanced AI chat experience:
code --install-extension syncable.syncable-ide-companionFeatures:
- Native diff views — Review file changes side-by-side in VS Code
- One-click accept/reject — Accept with
Cmd+Sor reject changes easily - Auto-detection — Works automatically when running
sync-ctl chatin VS Code's terminal
Without the extension:
- The agent still works but shows diffs in the terminal instead
| Variable | Description |
|---|---|
OPENAI_API_KEY |
OpenAI API key for chat (required for OpenAI provider) |
ANTHROPIC_API_KEY |
Anthropic API key for chat (required for Anthropic provider) |
SYNC_CTL_DEBUG |
Enable debug logging (set to any value) |
CARGO_PKG_VERSION |
CLI version (auto-set by Cargo) |
Setup:
# OpenAI
export OPENAI_API_KEY="sk-..."
# Anthropic
export ANTHROPIC_API_KEY="sk-ant-..."
# Debug mode
export SYNC_CTL_DEBUG=1| Code | Meaning |
|---|---|
0 |
Success |
1 |
Error occurred or security findings detected |
Exit Code Behavior:
vulnerabilitiescommand: Exits with1if critical or high severity vulnerabilities are foundsecuritycommand: Exits with1when--fail-on-findingsis used and findings are detected- All commands: Exits with
1on any error
- For Development: Use
--display detailedto see complete Docker analysis - For CI/CD: Use
--display summaryfor quick checks - For Security: Run
sync-ctl security . --fail-on-findingsin CI/CD - For Performance: Use
--mode lightningfor fastest security scans - For Debugging: Use
--verbosefor detailed logs - For Automation: Use
--jsonoutput with other tools - For Teams: Share vulnerability reports with
--outputoption - For Updates: Use
--clear-update-cacheto force update checks - For Monorepos: Use matrix view to see all projects at once
- For AI Help: Use
sync-ctl chatfor interactive assistance
- analyze — Project analysis with multiple display modes
- security — Turbo security engine with 5 scan modes
- vulnerabilities — Dependency vulnerability scanning
- dependencies — Comprehensive dependency analysis
- support — Technology support information
- tools — Vulnerability tool management
- chat — AI assistant with multiple providers
- auth — Platform authentication
- generate — IaC file generation (basic implementation done)
- Enhanced monorepo generation with per-project IaC files
- Advanced compliance framework checking
- validate — IaC validation and best practices checking
- Cloud Integration — Deploy directly to cloud platforms
- Monitoring Setup — Automated monitoring configuration
- Performance Analysis — Resource optimization recommendations
- Interactive Mode — Guided setup and configuration wizard
# Get help with any command
sync-ctl --help # Show all available commands
sync-ctl analyze --help # Show analyze command options
sync-ctl generate --help # Show generation options
sync-ctl security --help # Show security scanning options
sync-ctl vulnerabilities --help # Show vulnerability check options
sync-ctl dependencies --help # Show dependency analysis options
sync-ctl tools --help # Show tool management options
sync-ctl chat --help # Show AI chat options
sync-ctl auth --help # Show authentication options- GitHub: github.com/syncable-dev/syncable-cli
- Website: syncable.dev
- Issues: github.com/syncable-dev/syncable-cli/issues
- Contributing: CONTRIBUTING.md
- Changelog: CHANGELOG.md
Built with 🦀 Rust — Your AI-Powered DevOps Engineer in the Terminal