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.13.tar.gz (56.8 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.13-py3-none-any.whl (60.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dot_agent_kit-0.1.13.tar.gz
Algorithm Hash digest
SHA256 3c1f90cccb166f6f4fe553178b517023a5f000536748da1e4df965bb89d29926
MD5 fc067605540fa45413d7e45125d30b52
BLAKE2b-256 e5d0ea9e25ed530e6d332b3454fca7daaae63c89754bd035a58749de4bc5e2f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dot_agent_kit-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 e8b900ae5d763be3be25fefd95e4deb386e725156835e6f7c8ed78a15ecb8007
MD5 28e75a8897b859d5d55cc5858c4bb938
BLAKE2b-256 441521d45305fea828a3cc8ac8ccafe68a116478b4986767e79df4b0b9fd0ce5

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