Skip to main content

Decision logging for AI-assisted development - automatic tracking, git integration, and context for AI agents

Project description

logmind

PyPI Python versions CI skills.sh License: MIT

AI decision logging for development projects — branch-aware by default.

Why logmind

Codebases lose the why behind their code faster than the what. logmind captures architectural and implementation decisions as you make them, attaches them to the relevant git branch, and surfaces them to the next human or AI that works in the repo. One CLI command per decision; the package handles the docs, the branch routing, and the merge-time aggregation.

Key concept: Install once, init anywhere, log everything. Feature branches get their own decision file; on PR merge a GitHub Action appends a one-line summary to docs/decisions.md linking the PR + the branch detail. AGENTS.md is the canonical agent-instruction file; per-tool files (CLAUDE.md, .cursorrules, ...) are 2-line stubs pointing to it.

Installation

# Using pipx (recommended)
pipx install logmind

# Using Homebrew (macOS/Linux)
brew tap thrillmade/logmind
brew install logmind

# Using pip
pip install logmind

Required repo settings

logmind init ships a GitHub Action (regen-timeline.yml) that VERIFIES docs/timeline.md is up to date on every PR — fail-fast if stale, no auto-commit. For the derived-file architecture to stay conflict-free between concurrent PRs, your repo needs:

  • Strict required status checks on mainSettings → Branches → Branch protection rule (or Ruleset)"Require branches to be up to date before merging". This forces a PR to be rebased on latest main before merge, which is what makes docs/timeline.md (and any other derived file) conflict-free across concurrent PRs.

Without that toggle, two PRs in flight can both regenerate against different base commits and merge-conflict on the derived file.

One-command setup via reporulez

If you'd rather not click through the GitHub UI, the clud-bug-logmind variant of reporulez ships the canonical ruleset for repos using both logmind and clud-bug — strict status checks pinned to logmind's check names, required thread resolution, squash-only, the works:

curl -fsSL https://raw.githubusercontent.com/thrillmade/reporulez/main/bin/apply.sh \
  | bash -s -- owner/your-repo clud-bug-logmind

Quick Start

# If installed via pipx/brew, it's already available globally

# Initialize in your project
cd your-project
logmind init

# Log decisions - Python API
from logmind import log
log("Chose FastAPI over Flask",
    reasoning="Need async/await for WebSocket handling")

# Or use CLI
logmind log "Use PostgreSQL for database" \
  -r "Need ACID compliance" \
  -a "MongoDB" -a "SQLite"

# View and search decisions
logmind show
logmind search "postgres"

# Log with a built-in template (pre-fills reasoning, alternatives, implications)
logmind log --template database "Use PostgreSQL"
logmind templates   # list all available templates

# Analytics and stats
logmind stats
logmind stats --months 6

# Aggregate decisions across multiple projects
logmind aggregate ~/projects/api ~/projects/frontend
logmind aggregate --summary ~/work/*/

# Enforce decision logging with a pre-commit hook
logmind install-hook          # installs .git/hooks/pre-commit
logmind check-decisions       # run manually or in CI

# Manage AI agents
logmind agents list
logmind agents add windsurf

# View and modify configuration
logmind config list
logmind config get git.auto_push
logmind config set git.auto_push false

# Upgrade logmind
logmind update

# Auto-log with decorators
from logmind import log_decision, log_choice

@log_decision(
    decision="Authenticate user with {method}",
    reasoning="Security checkpoint"
)
def authenticate(method="oauth"):
    # Your auth code
    return True

@log_choice(
    choices={
        "redis": "Use Redis for caching",
        "memory": "Use in-memory caching",
    }
)
def select_cache():
    return "redis" if is_production() else "memory"

Contributing / Development Setup

Working on logmind itself? Set it up like any CLI tool:

# Clone the repo
git clone https://github.com/thrillmade/logmind.git
cd logmind

# Install globally in editable mode (like npm, git, docker)
pipx install -e .

# Now just use it!
logmind log "Add new feature" -r "Reasoning here"
logmind show
logmind search "keyword"

# Run tests
python3 -m venv venv
source venv/bin/activate
pip install -e ".[dev]"
pytest

Why pipx? logmind is a CLI tool, not a library. It should be globally available like git or npm.

Framework Integrations

# LangChain — auto-log agent decisions (pip install logmind[langchain])
from logmind.integrations import LangChainLogger

chain = LLMChain(llm=llm, callbacks=[LangChainLogger()])

# Custom framework — subclass BaseIntegration
from logmind.integrations.base import BaseIntegration

class MyLogger(BaseIntegration):
    def on_decision(self, output):
        self.log(f"Chose: {output}", reasoning="My framework decided")

See docs/custom-integrations.md for patterns, examples, and publishing guide.

Documentation

How It Works

  1. Install logmind as a package
  2. Init creates docs/ folder and inserts instructions into CLAUDE.md (preserving existing content)
  3. Log a decision - appends, archives old ones (keeps 20 recent), regenerates tree, commits, and pushes
  4. Context AI agents read the 20 most recent decisions and current file structure

Why logmind?

  • Simple: Two markdown files (recent + archive), no database
  • Focused: Only 20 most recent decisions for relevant AI context
  • Git-native: Every decision is a commit, git history is your audit trail
  • AI-friendly: Recent decisions + file structure = complete context
  • Automatic: Commits and pushes on every log

See docs/plan.md for complete architecture and roadmap.


Part of the thrillmade SkDD toolchain

Skills-Driven Development (Zak Elfassi's methodology) gives you the loop; the thrillmade toolchain ships the parts:

  • logmind — the why behind every change (decision logging as commit primitive); skill-creation + testing + auditing
  • clud-bug — skill-driven PR review at gate time; every finding cites the skill that motivated it
  • agent-skills — public catalog of reusable skills
  • skills.sh — skill discovery + install

End-to-end agentic auto dev: write skills first → log the why → run them against PRs → iterate based on usage. The tools work independently; better together.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

logmind-0.6.1.tar.gz (213.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

logmind-0.6.1-py3-none-any.whl (138.9 kB view details)

Uploaded Python 3

File details

Details for the file logmind-0.6.1.tar.gz.

File metadata

  • Download URL: logmind-0.6.1.tar.gz
  • Upload date:
  • Size: 213.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for logmind-0.6.1.tar.gz
Algorithm Hash digest
SHA256 eea0588a8939ba6d987e938a4725a5d7d5b646e2d7d2d4c5baf16449054a7910
MD5 901df6209ea1b2253a578f3ece7a41ab
BLAKE2b-256 19a750ba0e68dc8686543a4de6f17cc70d750cc88569d4db8c810471bc43ee1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for logmind-0.6.1.tar.gz:

Publisher: publish.yml on thrillmade/logmind

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file logmind-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: logmind-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 138.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for logmind-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 490d6f25f3b617c246a6f380823612e48e04318ad45d7c9ac4e9e464e158544d
MD5 35b5737e763fe9c5804a1b7085eb6d74
BLAKE2b-256 9fb9d346f8c409b91d74d6a4592da74798671cc0e346b4c14753783957cbee28

See more details on using hashes here.

Provenance

The following attestation bundles were made for logmind-0.6.1-py3-none-any.whl:

Publisher: publish.yml on thrillmade/logmind

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page