Skip to content
Gideon Docs 🛡️

Quick Start

Quick Start 🚀

Section titled “Quick Start 🚀”

Get Gideon up and running on your local machine to start performing automated security research.

Prerequisites

Section titled “Prerequisites”
  • Bun v1.3.6 or higher.
  • API keys for at least one LLM provider (OpenRouter recommended).
  • Optional: API keys for search/security data (Exa, VirusTotal, etc.).

Installation

Section titled “Installation”

1. Clone the Repository

Section titled “1. Clone the Repository”
Terminal window
git clone https://github.com/cogensec/gideon.git
cd gideon

2. Install Dependencies

Section titled “2. Install Dependencies”
Terminal window
bun install

3. Setup Environment Variables

Section titled “3. Setup Environment Variables”

Copy the example environment file and add your API keys.

Terminal window
cp env.example .env

Edit the .env file:

Terminal window
# Recommended for multi-model access
OPENROUTER_API_KEY=your_key_here


# Required for deep research
EXA_API_KEY=your_key_here

Running Gideon

Section titled “Running Gideon”

Interactive Mode

Section titled “Interactive Mode”

Launch the Gideon shell for natural language queries:

Terminal window
bun start

Specialized Commands

Section titled “Specialized Commands”

You can also run specific security tasks directly from the CLI:

  • Security Briefing: bun start brief
  • CVE Lookup: bun start cve CVE-2024-1234
  • IOC Reputation: bun start ioc 8.8.8.8

What’s Next?

Section titled “What’s Next?”

Learn more about Gideon’s Core Architecture or explore the Modular Skill System.