Documentation

Everything you need to install, configure, and get the most from AI Cockpit.

Want to see it before you read about it? play_arrow Live Demo — try it now

In-app User Guide, searchable and section-linked, no external browser needed

The full User Guide and Setup Guide open inside the app itself — searchable, with back/forward and previous/next navigation. No external browser needed, useful on systems that don't have one handy.

description

README

Project overview, requirements, quick start, architecture diagram.

settings

Setup Guide

Step-by-step setup from Apache + PHP through CLI authentication and first launch. Same content as inside the app.

menu_book

User Guide

How to use every feature — agents, modes, RAG, attachments, proposals, themes, and more. Same content as inside the app.

build

Configuration Guide

paths.json, API keys, tool definitions, capabilities, attachment routing, scheduler, and advanced options.

smart_toy

AI-Agent Setup

Teach any AI assistant (Claude, ChatGPT, Gemini, or a local agent) to help run and deploy your Cockpit — safely, without handling your passwords.

Quick Reference

Keyboard shortcuts

Ctrl+Enter — Send prompt
Escape — Cancel in-flight response
↑ (first line) — Previous prompt
↓ (last line) — Next prompt / restore draft
Ctrl+Shift+R — Hard reload after deploy

%%MARKER%% Protocol

%%CREATE:path%% … %%END%% — Write file
%%WORKER:provider:task:prompt%% — Call cloud API
%%TOOL:tool:preset:input_path%% — Run local CLI
%%PROPOSE:snippet%% … %%END%% — Propose code

Deploy pattern (after every change)

sudo cp ~/Downloads/<file> /var/www/html/cockpit/<file> sudo chown www-data:www-data /var/www/html/cockpit/<file> sudo chmod 644 /var/www/html/cockpit/<file> # Then Ctrl+Shift+R in browser

Start / stop

~/scripts/cockpit_start.sh # Start tmux sessions ~/scripts/cockpit_stop.sh # Stop all sessions tmux ls # Check session state tmux attach -t cockpit-claude # Debug a session

Key File Locations

/var/www/html/cockpit/ Web root index.html Main UI (~27,000 lines) bridge.php Streaming queue library.php RAG backend workers.php Cloud LLM dispatch tools.php Local CLI execution themes.php Theme registry (36 themes) attachments.php Per-chat attachment storage paths.json Runtime path config ← edit this for your paths ~/scripts/ agent_loop.sh Per-agent queue watcher crud_executor.sh %%MARKER%% dispatcher cockpit_start.sh Start all tmux sessions cockpit_stop.sh Stop all sessions ~/scripts/cockpit_data/ All persistent data — back this up! snippets/ Accumulator code snippets (JSON) knowledge/ Accumulator knowledge items (JSON) workers_keys.enc Encrypted API keys (AES-256-GCM) <projects_root>/ Project data (set in paths.json by the installer) <project>/ chat_<name>_contexts/ Attachments + summaries COCKPIT.md Per-project agent context