Skip to main content

A lightweight global Markdown spec and decision vault for AI coding agents.

Project description

Agent Spec Vault

agent-spec-vault is a tiny global Markdown vault for AI coding agents.

It stores durable specs, cross-repo contracts, and decisions in plain Markdown under a user-level directory. It is intentionally not a task tracker, Kanban board, daemon, hook system, or project management platform.

Why

Coding agents often need historical context:

  • previous product and architecture specs
  • cross-repository contracts
  • decisions and tradeoffs
  • validation rules that should survive chat resets

Tools such as Beads and Backlog.md are great when you need task tracking. This tool keeps the narrower part: Markdown-native, agent-readable specs and decisions that are global rather than tied to one repository.

Install

For most Python environments:

python3 -m pip install agent-spec-vault
specv init

If your Python installation blocks global CLI installs, or you prefer isolated command-line tools:

pipx install agent-spec-vault
specv init

Inside a virtual environment:

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install agent-spec-vault
specv init

Unreleased development builds can still be installed from GitHub:

pipx install git+https://github.com/xixifast/agent-spec-vault.git

For local development from a checkout:

python3 -m pip install -e .

Or run from a checkout without installing:

python3 -m specv --help

Quick Start

specv init
specv new "Quality analysis display contract" \
  --repos lippi-smart-customer,aics-web-repos,lippi-dingagent-graph-engine \
  --tags quality-analysis,contract \
  --current-codex-session
specv decision "Use Markdown vault instead of Beads for historical specs" \
  --tags tooling,specs \
  --codex-session 019f2767-c31f-7e31-b1e5-a0274051789d
specv link-session spec-20260704-process-trace-running \
  --codex-session 019f1111-example,019f2222-example
specv list
specv search "quality analysis"
specv show spec-20260703-quality-analysis-display-contract
specv index --print
specv prime --repo lippi-smart-customer

Default vault location:

~/.agents/spec-vault

Override it with:

SPECV_HOME=/path/to/vault specv list
specv --home /path/to/vault list

Data Model

Everything is ordinary Markdown:

~/.agents/spec-vault/
  README.md
  index.jsonl
  templates/
    spec.md
    decision.md
  specs/
    2026-07-03-quality-analysis-display-contract.md
  decisions/
    2026-07-03-use-markdown-vault.md

Each document has a small frontmatter block:

---
id: spec-20260703-quality-analysis-display-contract
kind: spec
title: Quality analysis display contract
status: active
created: 2026-07-03
updated: 2026-07-03
repos:
  - lippi-smart-customer
  - aics-web-repos
tags:
  - quality-analysis
  - contract
codex_sessions:
  - 019f2767-c31f-7e31-b1e5-a0274051789d
---

specv index writes index.jsonl, a compact surface for scripts and agents.

Commands

Command Purpose
specv init Create the vault directories and templates
specv new <title> Create a new spec
specv decision <title> Create a decision note
specv link-session <ref> Attach one or more Codex session ids to a document
specv list List specs and decisions
specv search <query> Search metadata and Markdown body
specv show <id> Print one document
specv index Regenerate index.jsonl
specv prime Print an agent-friendly summary
specv path Print the vault path

Suggested Agent Rule

Add a small rule to your global agent instructions:

When a task needs historical specs, cross-repo contracts, or prior design
decisions, search ~/.agents/spec-vault first with specv search or rg. When asked
to preserve a durable spec or decision, write it there instead of creating an
ad hoc file in a business repository.

Scope

This project does:

  • global spec and decision storage
  • Markdown-native files
  • frontmatter metadata for repos, tags, status, and dates
  • multiple Codex session links per spec or decision
  • JSONL index generation
  • agent-friendly summary output

This project does not:

  • track task claim/close state
  • manage dependencies or blockers
  • run a daemon or hooks
  • replace GitHub Issues, Beads, or Backlog.md
  • write into business repositories by default

Development

python3 -m unittest discover -s tests -p 'test_*.py'
python3 -m specv --home /tmp/specv-demo init

License

MIT

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

agent_spec_vault-0.1.2.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

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

agent_spec_vault-0.1.2-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file agent_spec_vault-0.1.2.tar.gz.

File metadata

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

File hashes

Hashes for agent_spec_vault-0.1.2.tar.gz
Algorithm Hash digest
SHA256 677c7b7cfab49b09c432f0126b59c62e51144320abdd35b5e4414d35de83acab
MD5 e10271e8745fa70dc0ccb7a48383cdf4
BLAKE2b-256 f5bda70a91de4b587108ac61d4d7efeb345ade4723de481d9f8fd03175c015f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_spec_vault-0.1.2.tar.gz:

Publisher: publish-to-pypi.yml on xixifast/agent-spec-vault

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

File details

Details for the file agent_spec_vault-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_spec_vault-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 393d3ad5dd26711fe00e668b508f71a727bc945510a1f598cfe4bb74f0316f31
MD5 f1ed29de1659a9dbf0b88926123ebaf3
BLAKE2b-256 5f54998e62720d894564eca9d9274ba00dda13337be79aaf553d6a19be6ca15b

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_spec_vault-0.1.2-py3-none-any.whl:

Publisher: publish-to-pypi.yml on xixifast/agent-spec-vault

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