PlanOpticon
PlanOpticon
- Home
- Getting Started Getting Started
- User Guide User Guide
- Use Cases
- CLI Reference
- Architecture Architecture
- API Reference API Reference
- FAQ & Troubleshooting
- Contributing
Cloud Sources¶
PlanOpticon connects to 20+ source platforms for fetching videos, documents, and notes.
Google Drive¶
Service account auth¶
For automated/server-side usage:
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account.json"
planopticon batch --source gdrive --folder-id "abc123" -o ./output
OAuth2 user auth¶
For interactive usage with your own Google account:
Install¶
Google Workspace (gws)¶
Full Google Workspace integration beyond just Drive. Access Docs, Sheets, Slides, and Meet recordings through the gws CLI group.
Setup¶
A single Google OAuth session covers Drive, Docs, Sheets, Slides, and Meet.
Usage¶
# List all Google Workspace content
planopticon gws list
# List only Google Docs
planopticon gws list --type docs
# List Meet recordings
planopticon gws list --type meet
# Fetch a specific file
planopticon gws fetch abc123def --output ./downloads
# Ingest an entire Drive folder into a knowledge base
planopticon gws ingest --folder-id abc123 --output ./kb --recursive
Microsoft 365 (m365)¶
Access OneDrive, SharePoint, Teams recordings, and Outlook content.
Setup¶
# Set your Azure AD app credentials
export MICROSOFT_CLIENT_ID="your-client-id"
export MICROSOFT_CLIENT_SECRET="your-client-secret"
# Authenticate
planopticon auth microsoft
Usage¶
# List all Microsoft 365 content
planopticon m365 list
# List only Teams recordings
planopticon m365 list --type teams
# List SharePoint files from a specific site
planopticon m365 list --type sharepoint --site "Engineering"
# Fetch a specific file
planopticon m365 fetch item-id-123 --output ./downloads
# Ingest SharePoint content into a knowledge base
planopticon m365 ingest --site "Engineering" --path "/Shared Documents" --output ./kb --recursive
Dropbox¶
OAuth2 auth¶
Install¶
YouTube¶
PlanOpticon can ingest YouTube videos by URL. Audio is extracted and transcribed, and any visible content (slides, diagrams) is captured from frames.
# Ingest a YouTube video
planopticon ingest "https://www.youtube.com/watch?v=example" --output ./kb
# Ingest a playlist
planopticon ingest "https://www.youtube.com/playlist?list=example" --output ./kb
YouTube ingestion uses yt-dlp under the hood. Install it separately if not already available:
Meeting recordings¶
Access cloud recordings from Zoom, Microsoft Teams, and Google Meet.
Zoom¶
# Set credentials and authenticate
export ZOOM_CLIENT_ID="your-client-id"
export ZOOM_CLIENT_SECRET="your-client-secret"
planopticon auth zoom
# List recent Zoom recordings
planopticon recordings zoom-list
# List recordings from a date range
planopticon recordings zoom-list --from 2026-01-01 --to 2026-02-01
Microsoft Teams¶
# Authenticate with Microsoft (covers Teams)
planopticon auth microsoft
# List Teams recordings
planopticon recordings teams-list
# List recordings from a date range
planopticon recordings teams-list --from 2026-01-01 --to 2026-02-01
Google Meet¶
# Authenticate with Google (covers Meet)
planopticon auth google
# List Meet recordings
planopticon recordings meet-list --limit 10
Notes sources¶
PlanOpticon can ingest notes and documents from several note-taking platforms.
Obsidian¶
Ingest an Obsidian vault directly. PlanOpticon follows wikilinks and parses frontmatter.
Notion¶
# Set your Notion integration token
export NOTION_API_KEY="secret_..."
# Authenticate
planopticon auth notion
# Export knowledge base to Notion
planopticon export notion --input ./kb --parent-page abc123
Apple Notes¶
PlanOpticon can read Apple Notes on macOS via the system AppleScript bridge.
GitHub¶
Ingest README files, wikis, and documentation from GitHub repositories.
# Set your GitHub token
export GITHUB_TOKEN="ghp_..."
# Authenticate
planopticon auth github
# Ingest a repo's docs
planopticon ingest "github://ConflictHQ/PlanOpticon" --output ./kb