⚡ Installation (Linux / macOS / Windows)

Install PHANTOM and configure the phantom CLI command across any terminal in a single command:

Linux & macOS (Bash/Zsh/Fish/etc.):

curl -fsSL https://raw.githubusercontent.com/OmYarewar110/PHANTOM/main/install.sh | bash

Windows (PowerShell):

iwr -useb https://raw.githubusercontent.com/OmYarewar110/PHANTOM/main/install.ps1 | iex

Once installed, launch PHANTOM from any terminal window instantly:

# 🚀 Launch PHANTOM server
phantom start

# 💻 Launch in development mode (Backend + Vite UI)
phantom dev

# 🔌 Specify custom port
phantom start --port 8080

# ❓ View CLI menu & options
phantom --help

Open http://localhost:1337 (or http://localhost:5173 in dev mode) in your browser.

---

👩‍💻 Developer Setup (Manual Installation)

For developers contributing to PHANTOM or customizing the codebase:

# 1. Clone the repository
git clone https://github.com/OmYarewar110/PHANTOM.git
cd PHANTOM

# 2. Install dependencies
npm install

# 3. Configure environment
cp .env.example .env

# 4. Start development mode
npm run dev

# 5. Run test suite
npm test

---

🤔 Why PHANTOM?

• Zero-Config Tool Execution: Tools automatically install system dependencies and parse outputs cleanly, so the AI never gets stuck missing a library.
• Unbounded Agent Loops: Unlike standard chat UIs, PHANTOM allows the LLM to call tools recursively until the goal is achieved without needing constant human prompting.
• Persistent Context: The integrated SQLite memory store gives your agent long-term recall across sessions, preventing repetitive scanning or reconnaissance.

✨ Features

Feature	Description
🛡️ Multi-Agent Defense	Orchestrator, Planner, and Specialist Agents (Log, Compliance, Threat Modeler) working in parallel via Task Graphs
🤖 Any LLM Backend	OpenAI, OpenRouter, Ollama, LM Studio, DeepSeek, Claude — any OpenAI-compatible API
⚡ Real-Time Streaming	Live tool execution output, typing animations, and AI thinking display
🔓 Unlimited Operations	No tool call limits — PHANTOM runs autonomously until the task is done
🧠 Self-Improving	Creates its own tools, saves execution traces, learns from past runs
🔑 Secure Sudo	One-time sudo password with system validation — persisted securely
📁 Workspace System	Configurable workspace directory for scripts, reports, and file operations
🧩 MCP Server Hub	Native Model Context Protocol infrastructure supporting typed JSON schemas and rate-limited endpoints
📦 Skills System	Trust-tiered SKILL.md packages utilizing isolated-vm sandboxing
🌐 Web Research	Built-in web search and webpage scraping for real-time information
🕷️ Scrapling Integration	Anti-bot bypass, Cloudflare solving, JS rendering via Scrapling
💾 Semantic Memory	Local Vector Search (@xenova/transformers) paired with standard FTS
🛑 Emergency Stop	Instant abort button to halt any running operation
🎨 Premium Dark UI	Includes live animated Canvas graph of multi-agent communication
🌐 Internet Crawling	Zero-config web reading, YouTube subtitles, RSS feeds, V2EX via Agent Reach integration

⚙️ Configuration

Edit .env or configure via the Web UI Settings panel:

# OpenAI
API_BASE_URL=https://api.openai.com/v1
API_KEY=sk-your-key-here
MODEL_ID=gpt-4o

# OpenRouter (access to 100+ models)
API_BASE_URL=https://openrouter.ai/api/v1
API_KEY=sk-or-your-key-here
MODEL_ID=deepseek/deepseek-chat

# Ollama (local, free)
API_BASE_URL=http://localhost:11434/v1
API_KEY=ollama
MODEL_ID=llama3

🐳 Docker Deployment

Run PHANTOM in a containerized environment using Docker Compose:

docker compose up --build

Open http://localhost:3000 in your browser.

🏗️ Architecture

PHANTOM/
├── bin/                    # PHANTOM CLI executable script (phantom)
├── install.sh              # 1-line curl installer script
├── server/                 # Backend (Express + WebSocket)
│   ├── ai/
│   │   ├── llm-client.js   # LLM communication & streaming
│   │   └── system-prompt.js # Dynamic system prompt builder
│   ├── tools/
│   │   ├── executor.js      # Tool execution engine (25 tools)
│   │   └── registry.js      # Tool definitions for function calling
│   ├── memory/
│   │   └── store.js         # SQLite persistence layer
│   ├── banner.js            # Colorful ANSI terminal banner
│   ├── config.js            # Configuration management
│   └── index.js             # Server entry point
├── frontend/               # Frontend (Vanilla JS + Vite)
│   ├── css/styles.css       # Dark theme design system
│   ├── js/
│   │   ├── app.js           # Main controller & WebSocket
│   │   ├── chat.js          # Chat rendering & animations
│   │   └── settings.js      # Settings panel
│   └── index.html           # Main page
├── workspace/              # AI workspace (scripts, reports, skills)
├── .env.example            # Configuration template
├── vite.config.js          # Vite dev server config
└── package.json

🛠️ Available Tools

PHANTOM has 25 built-in tools that the AI uses autonomously:

Tool	Purpose
execute_command	Run shell commands with auto sudo injection
read_file	Read file contents
write_file	Write/create files
list_directory	List directory contents
install_tool	Auto-install packages (apt/pacman/pip/npm/go/cargo)
web_request	HTTP requests for recon & API testing
search_web	Web search via DuckDuckGo
scrape_webpage	Fetch & parse webpage content
scrapling_fetch	Advanced scraping — anti-bot bypass, Cloudflare, JS rendering (Scrapling)
python_execute	Execute Python code directly
save_memory	Store findings to AgentMemory engine (4-tier taxonomy)
recall_memory	Hybrid RRF search across persistent memory
get_memory_stats	Get AgentMemory Engine stats & top-recalled items
edit_source_code	Self-modify PHANTOM's own code
save_trace	Log execution traces for self-optimization
jina_read_url	Read any URL as clean Markdown
youtube_search	Search YouTube videos
youtube_get_subtitles	Extract YouTube video subtitles/transcripts
rss_read_feed	Read any RSS/Atom feed
v2ex_browse	Browse V2EX tech community
reddit_crawl	Reddit search and post/thread reading
linkedin_crawl	LinkedIn posts, jobs, and article reading

🧪 Testing

Run the Vitest test suite:

npm test

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.

⚠️ Disclaimer

PHANTOM is designed for authorized security testing only. Always obtain proper authorization before testing any systems. The developers are not responsible for misuse of this tool.

---