Guia passo a passo

Colocar o OpenClone em funcionamento

Escolha seu modo de implantação, configure sua IA e conecte os apps. Guia completo para todos os níveis.

Escolha seu caminho

Execute em sua própria máquina ou servidor caseiro. Mac Mini, Raspberry Pi ou qualquer dispositivo que você já possua. Controle total, custo zero.

1
Clone the repo
git clone https://github.com/PixxzR/openclone
cd openclone
2
Configure your environment
cp backend/.env.example backend/.env
# Edit .env:
#   API_KEY=your-secure-random-key
#   AI_PROVIDER=openai
#   AI_API_KEY=your-openai-key
3
Start the backend
cd backend
docker compose up -d
4
Verify it's running
curl http://localhost:8000/api/status
# → {"status":"ok","version":"1.0.0"}
5
Connect the app
# In the iOS or macOS app:
# Backend URL: http://your-local-ip:8000
# API Key: (same as API_KEY in .env)

Instalar os apps

Conecte o app desktop macOS ou o app móvel iOS ao seu backend. Ambos são assinados e prontos para usar.

Signed & notarized with an Apple Developer certificate — no Gatekeeper warning, opens like any Mac app.

1
Download the .dmg from GitHub Releases
# https://github.com/PixxzR/openclone/releases
# → OpenClone-x.x.x.dmg
2
Install the app
# Open the .dmg
# Drag OpenClone.app → /Applications
# Eject the .dmg
3
Connect to your backend
# Launch OpenClone
# Go to Settings
# Backend URL:  http://your-server-ip:8000
# API Key:      (same as API_KEY in your .env)
# → tap Connect
4
Install macOS plugins (optional)
# Switch to the "macOS Plugins" tab above
# to enable audio capture and screen OCR
Homebrew (coming soon): brew install --cask openclone

Skills de IA

Coloque um arquivo skill na sua ferramenta IA e ela saberá como pesquisar seu vault, ler seu formato e chamar a API.

Claude Code

Claude Code Skill

Gives Claude Code full context about your vault structure, file format, and API. Drop it once, use it everywhere.

openclone.claude.md
# OpenClone Memory Vault

## Vault Structure
Audio/YYYY-MM-DD.md  # meetings, system audio
Screen/YYYY-MM-DD.md # screen OCR every 30s
Web/YYYY-MM-DD.md    # browsing history

## Query Examples
Grep "meeting" in Audio/
Read vault/Screen/today.md

Install path:

~/.claude/skills/openclone.claude.md
Baixar
Cursor

Cursor Rules

Teaches Cursor about the vault layout, file format, source types, and backend API endpoints for your project.

openclone.cursorrules
# OpenClone Memory Vault — Cursor Rules

vault/Audio/YYYY-MM-DD.md # audio transcriptions
vault/Screen/YYYY-MM-DD.md # screen OCR
vault/Web/YYYY-MM-DD.md   # web browsing

## API
POST /api/v1/ingest  # write memories
GET  /api/search?q=  # search vault
POST /api/ask/stream # AI query (SSE)

Install path:

.cursorrules (project root)
Baixar
Any AI

Universal Context

A ready-to-paste context block that explains your memory vault to any AI: ChatGPT, Gemini, Claude web, etc.

openclone-context.md
# My Personal Memory — OpenClone Context

My vault captures:
• Audio — meetings, conversations
• Screen — OCR of active windows
• Web — sites visited, articles read
• Journal — voice notes

Format: Source/YYYY-MM-DD.md
with ### HH:MM timestamped entries

Install path:

Paste into any AI chat
Baixar
Claude Code →
cp openclone.claude.md
~/.claude/skills/
Cursor →
cp openclone.cursorrules
/your/project/.cursorrules
ChatGPT / Gemini →
Paste the content of
openclone-context.md

Descubra os apps

App iOS e app de desktop macOS. Conecte-os ao seu backend em segundos.

OpenClone iOS — Dashboard Dashboard
OpenClone iOS — Ask Ask
OpenClone iOS — Sources Sources
OpenClone iOS — Journal Journal
OpenClone iOS — Passive Passive
OpenClone iOS — Braindump Braindump

Watch it in action

Short demos of each key workflow — setup, capture, and querying your memory.

Video coming soon
→ videos/setup-5min.mp4
Setup ~2 min
Docker setup in 5 minutes
Clone, configure .env, docker compose up, verify running.
Video coming soon
→ videos/demo-ask-cli.mp4
CLI ~1 min
Querying memory with Claude Code CLI
Ask a question in the terminal, watch Claude search the vault and stream an answer.
Video coming soon
→ videos/demo-ios.mp4
iOS ~1.5 min
iOS companion app walkthrough
Dashboard, ask screen with live streaming, memory archive and settings.
Video coming soon
→ videos/demo-macos.mp4
macOS ~2 min
macOS desktop app overview
Dashboard with live plugins, ask screen with streaming, plugin management.
Videos to record (replace placeholders) click to expand

Record these short clips and place them in www/public/videos/. Recommended: MP4 (H.264), max 1080p, 30fps, keep clips under 2 minutes for fast loading.

setup-5min.mp4 ~90s
  • 1. Start with terminal open, show the git clone command
  • 2. cp .env.example .env → open .env in editor, fill API_KEY + AI_API_KEY
  • 3. docker compose up -d → show container starting
  • 4. curl /api/status → show {"status":"ok"} response
  • 5. End: open iOS or macOS app, enter URL + key, show "Connected" badge
demo-ask-cli.mp4 ~60s
  • 1. Open terminal in vault directory
  • 2. Run: claude (or your preferred CLI)
  • 3. Ask a question like "What did I work on last week?"
  • 4. Show the status events: "Searching Audio/...", "Reading..."
  • 5. Show the final streamed answer with memory references
demo-ios.mp4 ~90s
  • 1. Open app — show dashboard (stats, active plugins, brief)
  • 2. Tap Ask — type a question, show typing
  • 3. Show status indicator "Searching..." while streaming
  • 4. Show full answer with memory references
  • 5. Navigate to Memories — scroll through recent entries
  • 6. Quick peek at Settings
demo-macos.mp4 ~90s
  • 1. Show dashboard: vault count, active plugins (audio ●, screen ●)
  • 2. Navigate to Ask — type a question
  • 3. Show streaming response with "Reading..." status badge
  • 4. Navigate to Plugins — show mac-audio and mac-screen running
  • 5. Quick settings peek (AI provider, vault path)

Tip: use QuickTime screen recording on macOS, or iOS screen recording from Control Center. Export as .mp4.