Skip to content
Zanei
English
Esc
navigateopen⌘Jpreview
On this page

Quickstart

From install to your first timeline and agent integration. Takes about five minutes.

Requires macOS (Apple Silicon or Intel) — currently the only supported platform.

Install

Homebrew and GitHub Releases distribution are being prepared. Until they are available, build and install Zanei from source:

git clone https://github.com/KentoShimizu/zanei.git
cd zanei
cargo build --release
mkdir -p "$HOME/.cargo/bin"
install -m 755 target/release/zanei "$HOME/.cargo/bin/zanei"

Make sure $HOME/.cargo/bin is on your PATH.

Check permissions

Zanei doesn’t record your screen. Instead, depending on what you capture, it needs macOS permissions (Accessibility, Input Monitoring, Automation). Start with a diagnosis:

zanei doctor

If anything is missing, you’ll see what is needed, why, and how to grant it. Add --fix to open the relevant System Settings pane directly:

zanei doctor --fix

Start recording

zanei start

Recording starts in the background as a launchd agent. You can check on it at any time:

zanei status

Get your first timeline

Work normally for a bit, then pull up your recent history:

zanei timeline --since 15m

You get a session-structured, deduplicated Markdown timeline — the same form agents consume. For raw events, use zanei query --since 15m instead (see retrieving data).

Connect your agent (optional)

Place the skill file for your agent and print its MCP registration command:

zanei setup --agent claude

From now on, telling your agent “check what I was just working on and continue” lets it restore context from the timeline. See agent integration for supported agents and details.

Before you start recording

  • Data is stored in a local SQLite database (~/.local/state/zanei/store.sqlite) and is not sent anywhere.
  • Keystroke content is not recorded by default — only the fact that typing happened and the field type. To opt in explicitly, run zanei config set capture.text_content true, then restart recording with zanei stop && zanei start.
  • Events are deleted automatically after 48 hours by default (configurable in settings).
  • Apps and sites you don’t want recorded can be excluded before they are written with filters.

Was this page helpful?