Skip to content

getting-started.md

Latest commit

 

History

History
106 lines (73 loc) · 3.6 KB

getting-started.md

File metadata and controls

106 lines (73 loc) · 3.6 KB
Raw

Getting Started

Prerequisites

  • Docker and Docker Compose v2
  • An LLM provider credential — one of:
    • Tier-mapped API keys (works out of the box): Anthropic, OpenAI, Google Gemini, MiniMax, DeepSeek, xAI, Mistral, OpenRouter, Nvidia NIM
    • Local LLM: Ollama (OLLAMA_API_BASE + OLLAMA_MODEL)
    • Subscription OAuth (no per-token billing): Claude Max/Pro/Team, ChatGPT Pro/Plus/Team, Gemini Advanced, Microsoft Copilot Pro, xAI SuperGrok, Perplexity Pro
    • Other providers (Groq, Cohere, Together, Fireworks, Perplexity API, Azure, AWS Bedrock, Replicate, custom OpenAI-compatible gateway): supported via DECEPTICON_MODEL / DECEPTICON_LITELLM_MODELS ad-hoc registration

That's it. Everything else runs inside containers.

Install

curl -fsSL https://decepticon.red/install | bash

This installs the decepticon CLI to your system.

Configure

decepticon onboard

The interactive setup wizard guides you through:

  1. Authentication — API key, subscription OAuth (Claude / ChatGPT / Gemini / Copilot / SuperGrok / Perplexity), or local Ollama
  2. Provider — choose one of the tier-mapped providers, configure OAuth, or point at a local Ollama
  3. Credentials — API key, OAuth token, or endpoint URL (depending on auth method)
  4. Model Profile — eco (balanced), max (performance), test (development)
  5. LangSmith — Optional tracing for LLM observability

For detailed provider setup including OAuth configuration, see Setup Guide.

Configuration is saved to ~/.decepticon/.env. Run decepticon onboard --reset to reconfigure.

Launch

Terminal CLI (default):

decepticon

Starts all services (PostgreSQL, LiteLLM, LangGraph, Neo4j, sandbox, C2 server, web dashboard) and opens the interactive terminal UI.

Web Dashboard (browser):

The web dashboard starts as part of the default stack — it's reachable at http://localhost:3000 once decepticon (or make dev for contributors) is running.

First Real Engagement

  1. Launch Decepticon (decepticon) and open http://localhost:3000
  2. The Soundwave agent interviews you to define the engagement:
    • Target scope (IP range, URL, Git repo, file upload, or local path)
    • Threat actor profile
    • Rules of Engagement (authorized scope, timing, exclusions)
  3. Soundwave generates: RoE → ConOps → Deconfliction Plan → OPPLAN
  4. You review and approve the OPPLAN
  5. The autonomous loop begins

Important: Only run Decepticon against systems you own or have explicit written authorization to test. See the disclaimer in the main README.

Stopping Services

decepticon stop     # Stop all services, keep data
make clean          # Stop + remove all volumes (resets everything)

Check Service Status

decepticon status        # Show running services
decepticon logs          # Follow LangGraph logs (default)
decepticon logs litellm  # Follow a specific service's logs
decepticon kg-health     # Diagnose the Neo4j knowledge graph

Next Steps

Topic Doc
All CLI commands and keyboard shortcuts CLI Reference
All make targets Makefile Reference
Agent roles and middleware Agents
Model profiles and fallback chain Models
Engagement workflow (RoE → Execution) Engagement Workflow
Web dashboard features Web Dashboard
Contributing to Decepticon Contributing