PlanOpticon

planopticon / docs / getting-started / installation.md
Source Blame History 102 lines
f0106a3… leo 1 # Installation
f0106a3… leo 2
f0106a3… leo 3 ## From PyPI
f0106a3… leo 4
f0106a3… leo 5 ```bash
f0106a3… leo 6 pip install planopticon
f0106a3… leo 7 ```
f0106a3… leo 8
f0106a3… leo 9 ### Optional extras
f0106a3… leo 10
f0106a3… leo 11 ```bash
f0106a3… leo 12 # PDF export support
f0106a3… leo 13 pip install planopticon[pdf]
f0106a3… leo 14
f0106a3… leo 15 # Google Drive + Dropbox integration
f0106a3… leo 16 pip install planopticon[cloud]
f0106a3… leo 17
f0106a3… leo 18 # GPU acceleration
f0106a3… leo 19 pip install planopticon[gpu]
f0106a3… leo 20
f0106a3… leo 21 # Everything
f0106a3… leo 22 pip install planopticon[all]
f0106a3… leo 23 ```
f0106a3… leo 24
f0106a3… leo 25 ## From source
f0106a3… leo 26
f0106a3… leo 27 ```bash
c33fef2… leo 28 git clone https://github.com/ConflictHQ/PlanOpticon.git
f0106a3… leo 29 cd PlanOpticon
f0106a3… leo 30 pip install -e ".[dev]"
f0106a3… leo 31 ```
f0106a3… leo 32
f0106a3… leo 33 ## Binary download
f0106a3… leo 34
f0106a3… leo 35 Download standalone binaries (no Python required) from
c33fef2… leo 36 [GitHub Releases](https://github.com/ConflictHQ/PlanOpticon/releases):
f0106a3… leo 37
f0106a3… leo 38 | Platform | Download |
f0106a3… leo 39 |----------|----------|
f0106a3… leo 40 | macOS (Apple Silicon) | `planopticon-macos-arm64` |
f0106a3… leo 41 | macOS (Intel) | `planopticon-macos-x86_64` |
f0106a3… leo 42 | Linux (x86_64) | `planopticon-linux-x86_64` |
f0106a3… leo 43 | Windows | `planopticon-windows-x86_64.exe` |
f0106a3… leo 44
f0106a3… leo 45 ## System dependencies
f0106a3… leo 46
f0106a3… leo 47 PlanOpticon requires **FFmpeg** for audio extraction:
f0106a3… leo 48
f0106a3… leo 49 === "macOS"
f0106a3… leo 50
f0106a3… leo 51 ```bash
f0106a3… leo 52 brew install ffmpeg
f0106a3… leo 53 ```
f0106a3… leo 54
f0106a3… leo 55 === "Ubuntu/Debian"
f0106a3… leo 56
f0106a3… leo 57 ```bash
f0106a3… leo 58 sudo apt-get install ffmpeg libsndfile1
f0106a3… leo 59 ```
f0106a3… leo 60
f0106a3… leo 61 === "Windows"
f0106a3… leo 62
f0106a3… leo 63 Download from [ffmpeg.org](https://ffmpeg.org/download.html) and add to PATH.
f0106a3… leo 64
f0106a3… leo 65 ## API keys
f0106a3… leo 66
a0146a5… noreply 67 You need at least one AI provider API key **or** a running Ollama server.
a0146a5… noreply 68
a0146a5… noreply 69 ### Cloud providers
a0146a5… noreply 70
a0146a5… noreply 71 Set API keys as environment variables:
f0106a3… leo 72
f0106a3… leo 73 ```bash
f0106a3… leo 74 export OPENAI_API_KEY="sk-..."
f0106a3… leo 75 export ANTHROPIC_API_KEY="sk-ant-..."
f0106a3… leo 76 export GEMINI_API_KEY="AI..."
f0106a3… leo 77 ```
f0106a3… leo 78
f0106a3… leo 79 Or create a `.env` file in your project directory:
f0106a3… leo 80
f0106a3… leo 81 ```
f0106a3… leo 82 OPENAI_API_KEY=sk-...
f0106a3… leo 83 ANTHROPIC_API_KEY=sk-ant-...
f0106a3… leo 84 GEMINI_API_KEY=AI...
f0106a3… leo 85 ```
a0146a5… noreply 86
a0146a5… noreply 87 ### Ollama (fully offline)
a0146a5… noreply 88
a0146a5… noreply 89 No API keys needed — just install and run [Ollama](https://ollama.com):
a0146a5… noreply 90
a0146a5… noreply 91 ```bash
a0146a5… noreply 92 # Install Ollama, then pull models
a0146a5… noreply 93 ollama pull llama3.2 # Chat/analysis
a0146a5… noreply 94 ollama pull llava # Vision (diagram detection)
a0146a5… noreply 95
a0146a5… noreply 96 # Start the server (if not already running)
a0146a5… noreply 97 ollama serve
a0146a5… noreply 98 ```
a0146a5… noreply 99
a0146a5… noreply 100 PlanOpticon auto-detects Ollama and uses it as a fallback when no cloud API keys are set. For a fully offline pipeline, pair Ollama with local Whisper transcription (`pip install planopticon[gpu]`).
f0106a3… leo 101
f0106a3… leo 102 PlanOpticon will automatically discover which providers are available and route to the best model for each task.

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button