Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jasonkneen/openclicky/llms.txt

Use this file to discover all available pages before exploring further.

OpenClicky is an open-source macOS menu-bar app that puts a capable AI companion — Clicky — at your fingertips. Press a key to talk, ask about anything on your screen, run multi-step agentic tasks, and automate workflows using a rich skill system powered by Claude and other LLMs. Everything runs locally with your own API keys, no cloud sync required.

Installation

Build and run OpenClicky from source on macOS 14.2 or newer.

Configuration

Set up your API keys, secrets file, and provider preferences.

Voice Interaction

Push-to-talk, wake word, and pluggable transcription providers.

Agent Mode

Delegate multi-step tasks to Clicky’s Codex-powered agent runtime.

What OpenClicky Can Do

OpenClicky handles a wide range of tasks from a single, always-available menu-bar interface:

Screen-Aware Guidance

Clicky captures your screen on demand and points to UI elements using a native overlay cursor.

Skills & Integrations

40+ bundled skills covering GitHub, Google Workspace, Notion, Linear, Airtable, and more.

Automations

Schedule recurring prompts using cron expressions or time intervals.

Memory & Wiki

Persistent memory and a local wiki keep context across sessions.

For Developers

Swift SDK

Embed OpenClicky’s full runtime inside your own macOS app using OpenClickySDKSession.

External Control Bridge

Drive OpenClicky’s overlay, TTS, and screenshots over a local HTTP/SSE bridge at 127.0.0.1:32123.

Bridge Endpoints

Full reference for /cursor, /caption, /screenshot, /speak, /clear, and /events.

MCP Tools

Use MCP-style tool calls to integrate OpenClicky with agent runtimes.

Get Started

1

Build from source

Open cursor-buddy.xcodeproj in Xcode, set your signing team, and run the app with Cmd+R. Grant Accessibility, Microphone, and Screen Recording permissions when prompted.
2

Add your API keys

Create ~/.config/openclicky/secrets.env with your ANTHROPIC_API_KEY (required for voice responses) and optionally ELEVENLABS_API_KEY for natural TTS. See Configuration for all supported keys.
3

Start talking to Clicky

Click the OpenClicky menu-bar icon and press your configured push-to-talk shortcut. Clicky listens, captures screen context if needed, and responds with voice and on-screen guidance.
4

Enable Agent Mode

For multi-step tasks — writing code, researching topics, working with files — invoke Agent Mode. Clicky spawns a Codex-powered agent that can run shell commands, use bundled skills, and work autonomously.
OpenClicky requires macOS 14.2 or newer and Xcode with the macOS SDK. API keys are stored locally — nothing is synced to any OpenClicky-hosted service.

Build docs developers (and LLMs) love