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
1 maintainer
Metadata
1 maintainer
Release files for pulse-agent 3.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pulse_agent-3.1.1.tar.gz | 91.9 kB | With provenance | Details for pulse_agent-3.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pulse_agent-3.1.1-py3-none-any.whl | Python 3 | none | any | Details for pulse_agent-3.1.1-py3-none-any.whl |
Total release size: 213.8 kB
Release files / pulse_agent-3.1.1.tar.gz
| Download URL | pulse_agent-3.1.1.tar.gz |
|---|---|
| Size | 91.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f65c3c68b0ddd0c9ae4ee9a4f0cf0cd867401173ac2805b1739c89aa575d011
|
|
BLAKE2b-256 checksum How to use checksums |
76383ec7fcdbdaebd5b69f3f311c2e2624b07c15ef2f03a6c780f704a0766818
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 16, 2026.
Transparency logRelease files / pulse_agent-3.1.1-py3-none-any.whl
| Download URL | pulse_agent-3.1.1-py3-none-any.whl |
|---|---|
| Size | 121.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
89a3d78614687a0d361bbf132ac264d2d0ab77b5e78792896b9f3cd2d8ab6810
|
|
BLAKE2b-256 checksum How to use checksums |
720f9b7d8449bde871a7dbac867d0e6eab7faa842905832e1b7ff3b92c722665
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 16, 2026.
Transparency logSecurity for pulse-agent 3.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for pulse_agent-3.1.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 16, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
