pulse-agent 3.1.1

The self-hosted personal-data context layer for your agent.

pulseagent.dev · Documentation · Contributing

Ingest curated sources into a local store and Obsidian-style vault, then expose them over MCP so your agent does the reasoning — all self-hosted. Pulse does not call an LLM itself.

Pulse is still experimental and in active testing, so expect some rough edges and occasional changes. It is best suited for early adopters who are comfortable self-hosting.

Install

Install Script

curl -fsSL https://pulseagent.dev/install.sh | bash

Pip

pipx install pulse-agent   # or: uv tool install pulse-agent

Docker

docker pull ghcr.io/jeff7712/pulse:3.1.1

docker run -d --name pulse -p 8000:8000 \
  -v pulse-config:/config -v pulse-data:/data \
  ghcr.io/jeff7712/pulse:3.1.1 pulse onboard

From a clone: docker build -t pulse -f Dockerfile . or docker compose up --build -d. Quickstart — Docker for more details.

Defaults (native install): config under ~/.config/pulse, data under ~/.local/share/pulse (override with PULSE_CONFIG_DIR). Next: pulse configure → pulse init → pulse run — see Quickstart.

Documentation

Documentation lives under docs/ in this repository, or pulseagent.dev/docs. Paths and environment: Standalone app, CLI commands, and the MCP server use PULSE_DATABASE_PATH. That variable selects the SQLite event store; use PULSE_VAULT_PATH for vault markdown. Override the config directory with PULSE_CONFIG_DIR (default finds .config/pulse.toml under ~/.config/pulse). pulse and pulse-mcp read the same variables; day boundaries and scheduling use PULSE_TIMEZONE — see the Operations runbook.

Optional: local semantic search (pulse-agent[semantic], pulse embed) and scheduled proactive review ([proactive], pulse review) — see the configuration reference.

MCP

Use pulse-mcp with Claude Code, Cursor, OpenClaw, etc. Setup, client JSON, tools, and resources: MCP agent setup. Agent skills: skills/ (pulse-review, pulse-recall).

Send this to your agent:

Read https://raw.githubusercontent.com/JEFF7712/pulse/main/docs/self-hosting/mcp-agent-setup.md and follow every step to install Pulse (pulse-agent), ensure pulse.toml exists, and register pulse-mcp in my MCP settings for this machine.

Develop

uv sync --group dev && uv run pytest

Layout and contributor workflow: Contributing.

pulseagent.dev | PyPI | GitHub