Skip to main content

CLI tool for managing .agent/ automated documentation folders

Project description

dot-agent-kit

dot-agent-kit is a CLI companion that manages the .agent/ documentation directory in a repository. It installs the dot-agent command, ships curated mental-model documentation for tools like Graphite (gt), GitHub CLI (gh), and Workstack, and keeps local copies synchronized with the versions distributed by the package.

Installation

pip install dot-agent-kit
# or
uv add dot-agent-kit

Usage

# Initialize a repository with the default .agent layout
dot-agent init

# Update bundled documentation in the current .agent directory
dot-agent sync

# Preview updates without writing
dot-agent sync --dry-run

# List available documentation files
dot-agent list

# Extract one file explicitly
dot-agent extract tools/gt.md

# Compare local changes to the packaged version
dot-agent diff tools/gt.md

# Review sync status and pending updates
dot-agent check

Configuration

The tool writes .agent/.dot-agent-kit.yml to track which files are managed and the version of dot-agent-kit used the last time the folder was updated. Custom documentation can be added alongside the managed files; the CLI leaves entries listed under custom_files untouched.

Development

uv run pytest packages/dot-agent-kit/tests
uv run ruff format packages/dot-agent-kit
uv run pyright packages/dot-agent-kit/src

The package targets Python 3.13 and follows the Workstack coding standards (LBYL exception handling, absolute imports, Click for CLI output).

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

dot_agent_kit-0.1.12.tar.gz (37.3 kB view details)

Uploaded Source

Built Distribution

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

dot_agent_kit-0.1.12-py3-none-any.whl (40.3 kB view details)

Uploaded Python 3

File details

Details for the file dot_agent_kit-0.1.12.tar.gz.

File metadata

  • Download URL: dot_agent_kit-0.1.12.tar.gz
  • Upload date:
  • Size: 37.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.2

File hashes

Hashes for dot_agent_kit-0.1.12.tar.gz
Algorithm Hash digest
SHA256 dfc88d2d23e1d2f684e1cabdaf45a9e7e34faa81d1646226e41730fa93556642
MD5 f7ae849167997ca8e04d6a0648733085
BLAKE2b-256 7bce3912c182392f4c8528d6b60d844695e1ef4283e7af10626d608199b7080c

See more details on using hashes here.

File details

Details for the file dot_agent_kit-0.1.12-py3-none-any.whl.

File metadata

File hashes

Hashes for dot_agent_kit-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 30ef7c1c76ad6cbf4eef168e672f6d3aa0dee33520cffd2ad2c3c3521724b967
MD5 5b49bc2477f270b9ca51a221b89eac3c
BLAKE2b-256 b50faa6100d74bb6bedf47e04bfeddd82ecddf9a27b732fb1ba0fcc6c2c25fad

See more details on using hashes here.

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