diff --git a/README.md b/README.md index 97b8a818..0f1f0be4 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@

Syncable CLI

- Your AI-Powered DevOps Engineer in the Terminal + DevOps toolbox for AI coding agents and developers

CI Status Crates.io - docs.rs + npm
Downloads @@ -21,169 +21,173 @@
License - Rust 1.85+ + Rust 1.88+ Platform

Quick Start • - AI Agent • - Features • + AI Agent Skills • + Commands • Installation • Syncable Platform →

--- -> **🚀 Ready to deploy?** Take your infrastructure to production with [Syncable Platform](https://syncable.dev) — seamless cloud deployments, monitoring, and team collaboration built on top of this CLI. - ---- - ## What is Syncable CLI? -**Stop copy-pasting Dockerfiles from Stack Overflow.** Syncable CLI is an AI-powered assistant that understands your codebase and generates production-ready infrastructure — Dockerfiles, Kubernetes manifests, Terraform configs, and CI/CD pipelines — tailored specifically to your project. - -

- Syncable CLI Demo -

+Syncable CLI (`sync-ctl`) is a DevOps toolbox that analyzes codebases, scans for security issues, validates infrastructure files, and deploys to cloud providers. It works standalone from the terminal or through **AI coding agent skills** — giving Claude Code, Codex, Gemini CLI, Cursor, and Windsurf the ability to run security scans, check for CVEs, lint Dockerfiles, and deploy services through natural conversation. ## ⚡ Quick Start +### For AI coding agents (recommended) + ```bash -# Install -cargo install syncable-cli +npx syncable-cli-skills +``` + +This installs 11 skills (7 command + 4 workflow) into your AI coding agent. Then just ask: -# Start the AI Agent -sync-ctl chat +- *"assess this project"* — full health check +- *"scan for security issues"* — secrets and credential detection +- *"check for vulnerabilities"* — CVE scanning across all dependencies +- *"validate my Dockerfiles"* — lint IaC files +- *"deploy this service"* — cloud deployment with preview -# Or run a quick analysis +### For direct CLI use + +```bash +cargo install syncable-cli sync-ctl analyze . ``` -That's it. The agent analyzes your codebase, understands your stack, and helps you build infrastructure that actually works. +## 🤖 AI Agent Skills -## 🤖 AI Agent +One command installs skills for all major AI coding agents: -The Syncable Agent is like having a senior DevOps engineer available 24/7. It can: +```bash +npx syncable-cli-skills +``` -### Generate Infrastructure -- **Dockerfiles** — Optimized multi-stage builds for any language -- **Docker Compose** — Full local development environments -- **Kubernetes** — Deployments, services, ingress, and more -- **Terraform** — Cloud infrastructure as code -- **CI/CD** — GitHub Actions, GitLab CI, Jenkins pipelines +| Agent | Install Path | Format | +|-------|-------------|--------| +| **Claude Code** | Plugin marketplace | `SKILL.md` with plugin.json | +| **Codex** | `~/.agents/skills/` | `SKILL.md` directories | +| **Gemini CLI** | `~/.gemini//skills/` | `SKILL.md` directories | +| **Cursor** | `.cursor/rules/` | `.mdc` with `alwaysApply` | +| **Windsurf** | `.windsurf/rules/` | `.md` with `trigger: always` | -### Understand Your Code -- Detects **260+ technologies** across JavaScript, Python, Go, Rust, and Java -- Identifies architecture patterns (monolith, microservices, serverless) -- Maps service dependencies and port configurations -- Reads your existing configs and improves them +### What the skills teach your agent -### 🔌 VS Code Integration (Recommended) +**Command skills** — atomic wrappers around `sync-ctl` commands: -For the best experience, install the **Syncable IDE Companion** extension: +| Skill | What it does | +|-------|-------------| +| `syncable-analyze` | Detect tech stack, languages, frameworks, dependencies | +| `syncable-security` | Scan for secrets, hardcoded credentials, insecure patterns | +| `syncable-vulnerabilities` | Check dependencies for known CVEs across all ecosystems | +| `syncable-dependencies` | Audit licenses, production vs dev split, package details | +| `syncable-validate` | Lint Dockerfiles, Compose files, K8s manifests, Helm charts, Terraform | +| `syncable-optimize` | Analyze Kubernetes resource requests, limits, cost efficiency | +| `syncable-platform` | Authenticate, switch projects/environments, deploy to cloud | -```bash -code --install-extension syncable.syncable-ide-companion -``` +**Workflow skills** — multi-step orchestrations with decision logic: + +| Skill | What it does | +|-------|-------------| +| `syncable-project-assessment` | Full health check: stack + security + vulnerabilities + dependencies | +| `syncable-security-audit` | Deep pre-deployment review with paranoid-mode scanning | +| `syncable-iac-pipeline` | Validate all IaC files + Kubernetes optimization | +| `syncable-deploy-pipeline` | End-to-end: auth → analyze → security gate → deploy + monitor | + +### How it works -This enables: -- **Native diff views** — Review file changes side-by-side in VS Code -- **One-click accept/reject** — Accept with `Cmd+S` or reject changes easily -- **Auto-detection** — Works automatically when running `sync-ctl chat` in VS Code's terminal +Skills teach your AI agent to use `sync-ctl` with the `--agent` flag, which outputs compressed JSON instead of terminal formatting. The agent gets a summary with the key findings, plus a reference ID to retrieve full details on demand: -> Without the extension, the agent still works but shows diffs in the terminal instead. +```bash +# Agent runs this (compressed output, ~2KB) +sync-ctl security . --mode balanced --agent -### Chat Commands -| Command | Description | -|---------|-------------| -| `/model` | Switch AI model (GPT-4, Claude, etc.) | -| `/provider` | Switch between OpenAI and Anthropic | -| `/clear` | Clear conversation history | -| `/help` | Show available commands | +# Agent drills into details only when needed (paginated) +sync-ctl retrieve --query "severity:critical" --limit 10 +``` -### Keyboard Shortcuts -| Shortcut | Action | -|----------|--------| -| `Ctrl+J` | Insert newline (multi-line input) | -| `Shift+Enter` | Insert newline | -| `@filename` | Add file to context | -| `Ctrl+C` | Cancel / Exit | +This keeps the agent's context window small while giving access to the full data. -## 🔍 Features +## 🔍 Commands ### Project Analysis ```bash -sync-ctl analyze . +sync-ctl analyze . # Human-readable matrix view +sync-ctl analyze . --agent # Compressed JSON for agents ``` -Get a complete breakdown of your project — languages, frameworks, databases, ports, and architecture patterns. +Detects 260+ technologies across JavaScript, Python, Go, Rust, and Java ecosystems. ### Security Scanning ```bash -sync-ctl security +sync-ctl security . --mode balanced # Standard scan +sync-ctl security . --mode paranoid # Deep compliance audit ``` -Blazing-fast secret detection powered by Rust. Finds API keys, tokens, and credentials in seconds, not minutes. | Mode | Speed | Use Case | |------|-------|----------| -| `--mode lightning` | 🚀 Fastest | Pre-commit hooks | -| `--mode fast` | ⚡ Fast | Development | -| `--mode thorough` | 🔍 Complete | Security audits | -| `--mode paranoid` | 🕵️ Maximum | Compliance | +| `lightning` | Fastest | Pre-commit hooks | +| `fast` | Fast | Development | +| `balanced` | Standard | Default | +| `thorough` | Complete | PR reviews | +| `paranoid` | Maximum | Compliance audits | -### Vulnerability Checking +### Vulnerability Detection ```bash -sync-ctl vulnerabilities +sync-ctl vulnerabilities . # Scan all dependencies for CVEs +sync-ctl vulnerabilities . --severity high # Only high+ severity ``` -Scan your dependencies for known CVEs across npm, pip, cargo, and more. +Scans npm, pip, cargo, go, and Java dependencies. Automatically discovers and scans all subdirectories in monorepos. -## 📦 Installation - -### Cargo (Recommended) +### IaC Validation ```bash -cargo install syncable-cli +sync-ctl validate . # Lint all IaC files +sync-ctl validate . --types dockerfile,compose # Specific types +sync-ctl validate . --types compose --fix # Auto-fix issues ``` -### Linux/macOS -```bash -curl -sSL https://install.syncable.dev | sh -``` +| Linter | What it checks | Rules | +|--------|---------------|-------| +| **Hadolint** | Dockerfiles | 60+ rules | +| **Dclint** | Docker Compose | 15 rules (8 auto-fixable) | +| **Kubelint** | K8s manifests | 63+ security & best-practice checks | +| **Helmlint** | Helm charts | 40+ rules | -### Windows -```powershell -iwr -useb https://raw.githubusercontent.com/syncable-dev/syncable-cli/main/install.ps1 | iex +### Deployment +```bash +sync-ctl deploy preview . # Get deployment recommendation (JSON) +sync-ctl deploy run . --provider hetzner --port 8080 --public # Deploy +sync-ctl deploy status --watch # Monitor progress +sync-ctl deploy wizard # Interactive wizard (for humans) ``` -### From Source +### Platform Management ```bash -git clone https://github.com/syncable-dev/syncable-cli.git -cd syncable-cli -cargo install --path . +sync-ctl auth login # Authenticate with Syncable +sync-ctl project current # Show current context +sync-ctl org list # List organizations +sync-ctl project select # Switch project +sync-ctl env select staging # Switch environment ``` -## 🔧 Configuration +## 📦 Installation -### AI Provider Setup +### Cargo (recommended) ```bash -# OpenAI -export OPENAI_API_KEY="sk-..." - -# Anthropic -export ANTHROPIC_API_KEY="sk-ant-..." +cargo install syncable-cli ``` -### Project Config (`.syncable.toml`) -```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"] +### From source +```bash +git clone https://github.com/syncable-dev/syncable-cli.git +cd syncable-cli +cargo install --path . ``` ## 🌟 Supported Technologies @@ -203,11 +207,11 @@ ignore_patterns = ["node_modules", "target", "dist"] -## 🚀 What's Next? +## 🚀 Syncable Platform This CLI is the foundation of the **Syncable Platform** — a complete DevOps solution that takes you from code to production: -- **One-click deployments** to AWS, GCP, or Azure +- **One-click deployments** to AWS, GCP, Hetzner, or Azure - **Team collaboration** with shared environments - **Monitoring & logs** built-in - **Cost optimization** recommendations @@ -219,15 +223,10 @@ This CLI is the foundation of the **Syncable Platform** — a complete DevOps so We love contributions! Whether it's bug fixes, new features, or documentation improvements. ```bash -# Clone and build git clone https://github.com/syncable-dev/syncable-cli.git cd syncable-cli cargo build - -# Run tests cargo test - -# Check code quality cargo clippy && cargo fmt ``` @@ -246,21 +245,10 @@ of [Hadolint](https://github.com/hadolint/hadolint), originally written in Haske Lukas Martinelli and contributors. The Docker Compose linting functionality (`src/analyzer/dclint/`) is a Rust implementation -inspired by [docker-compose-linter](https://github.com/zavoloklom/docker-compose-linter) -by Sergey Suspended. - -See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) for full attribution details. - ---- +inspired by [dclint](https://github.com/zavoloklom/docker-compose-linter) by Sergey Kupletsky. -

- Built with 🦀 Rust -
- GitHub • - Website • - Issues -

+The Kubernetes manifest linting functionality (`src/analyzer/kubelint/`) is a Rust reimplementation +inspired by [KubeLinter](https://github.com/stackrox/kube-linter) by StackRox / Red Hat. -

- GitHub stars -

+The Helm chart linting functionality (`src/analyzer/helmlint/`) is a Rust implementation +inspired by the official [Helm lint](https://helm.sh/docs/helm/helm_lint/) command. diff --git a/src/cli.rs b/src/cli.rs index cb46304c..609c9b9b 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -4,9 +4,9 @@ use std::path::PathBuf; #[derive(Parser)] #[command(name = "sync-ctl")] #[command(version = env!("CARGO_PKG_VERSION"))] -#[command(about = "Generate Infrastructure as Code from your codebase")] +#[command(about = "DevOps CLI toolbox for AI coding agents and developers")] #[command( - long_about = "A powerful CLI tool that analyzes your codebase and automatically generates optimized Infrastructure as Code configurations including Dockerfiles, Docker Compose files, and Terraform configurations" + long_about = "Analyze tech stacks, scan for security issues and CVEs, validate IaC files, optimize Kubernetes resources, and deploy to cloud providers. Works standalone or through AI coding agent skills (Claude Code, Codex, Gemini CLI, Cursor, Windsurf)." )] pub struct Cli { #[command(subcommand)] @@ -361,7 +361,8 @@ pub enum Commands { offset: usize, }, - /// Start an interactive AI chat session to analyze and understand your project + /// [DEPRECATED] Start an interactive AI chat session. Use AI coding agent skills instead. + #[command(hide = true)] Chat { /// Path to the project directory (default: current directory) #[arg(value_name = "PROJECT_PATH", default_value = ".")] @@ -430,7 +431,8 @@ pub enum Commands { command: Option, }, - /// Run as dedicated AG-UI agent server (headless mode for containers) + /// [DEPRECATED] Run as dedicated AG-UI agent server. Use AI coding agent skills instead. + #[command(hide = true)] Agent { /// Path to the project directory #[arg(value_name = "PROJECT_PATH", default_value = ".")] diff --git a/src/main.rs b/src/main.rs index 54bdd73c..58837589 100644 --- a/src/main.rs +++ b/src/main.rs @@ -742,6 +742,15 @@ async fn run() -> syncable_cli::Result<()> { ag_ui, ag_ui_port, } => { + eprintln!( + "\n ⚠️ `sync-ctl chat` is deprecated and will be removed in a future release.\n" + ); + eprintln!(" Syncable CLI now works through AI coding agent skills instead."); + eprintln!(" Install skills with: npx syncable-cli-skills\n"); + eprintln!( + " Skills are available for: Claude Code, Codex, Gemini CLI, Cursor, Windsurf\n" + ); + // Handle --list-sessions flag first (before starting chat) if list_sessions { use syncable_cli::agent::persistence::{SessionSelector, format_relative_time}; @@ -1070,6 +1079,12 @@ async fn run() -> syncable_cli::Result<()> { provider, model, } => { + eprintln!( + "\n ⚠️ `sync-ctl agent` is deprecated and will be removed in a future release.\n" + ); + eprintln!(" Syncable CLI now works through AI coding agent skills instead."); + eprintln!(" Install skills with: npx syncable-cli-skills\n"); + // Agent command is handled by lib.rs syncable_cli::run_command( Commands::Agent {