CLI for sharing product Markdown documentation with local agent projects.
Project description
Disgust Docs CLI
disgust-docs connects product Markdown documentation repositories to local code projects so coding agents can read and update shared docs as normal files.
Install
After the package is published, install it as a regular CLI tool:
uv tool install disgust-docs
or:
pipx install disgust-docs
For pre-release installs directly from GitHub:
pipx install git+https://github.com/LebedAlIv2601/shareable-ai-md-docs.git
uv tool install git+https://github.com/LebedAlIv2601/shareable-ai-md-docs.git
Release
PyPI publishing is handled by .github/workflows/publish.yml.
Before the first release, configure PyPI Trusted Publishing for:
- project name:
disgust-docs - repository:
LebedAlIv2601/shareable-ai-md-docs - workflow:
publish.yml - environment:
pypi
Then create a version tag:
git tag v0.1.0
git push origin v0.1.0
Quick Start
disgust-docs init
disgust-docs add pizza git@github.com:org/pizza-docs.git --branch main --mode pr
disgust-docs sync pizza
disgust-docs edit pizza --branch docs/update-checkout-rules
disgust-docs publish pizza --message "Update checkout docs" --title "Update checkout docs"
The project commits .disgust-docs.yml and ignores .disgust-docs/.
V1 Model
- Each product has its own docs repository.
- The global git object cache lives under
~/.disgust-docs/mirrors/. - Each project gets a local docs worktree under
.disgust-docs/<alias>. readOnlydocs can be synced and inspected.prdocs can be edited through an explicit edit session and published through a GitHub PR usinggh.- Direct pushes to
mainare intentionally unsupported.
Generated indexes, automatic AGENTS.md patches, non-GitHub providers, and a dedicated agent skill are future extensions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file disgust_docs-0.1.0.tar.gz.
File metadata
- Download URL: disgust_docs-0.1.0.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
08571679a93f8746bf7309fd0bb7351f84586c6908968ba4724a95e4f8a329ea
|
|
| MD5 |
4acc2bb21d7bfdeebd4166b69994e14d
|
|
| BLAKE2b-256 |
96f09d45776a7d2c485289b68e6a15df0ef4277ec559958577af9214b7a799e4
|
Provenance
The following attestation bundles were made for disgust_docs-0.1.0.tar.gz:
Publisher:
publish.yml on LebedAlIv2601/shareable-ai-md-docs
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
disgust_docs-0.1.0.tar.gz -
Subject digest:
08571679a93f8746bf7309fd0bb7351f84586c6908968ba4724a95e4f8a329ea - Sigstore transparency entry: 2107802203
- Sigstore integration time:
-
Permalink:
LebedAlIv2601/shareable-ai-md-docs@23b09cf6fb0cdae1bc2f0484d04b3e713fb4f424 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/LebedAlIv2601
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@23b09cf6fb0cdae1bc2f0484d04b3e713fb4f424 -
Trigger Event:
push
-
Statement type:
File details
Details for the file disgust_docs-0.1.0-py3-none-any.whl.
File metadata
- Download URL: disgust_docs-0.1.0-py3-none-any.whl
- Upload date:
- Size: 12.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ada73f60f4b1be557e47f5c743805b5cf47dd297b403852a6b6db08c8f62a66
|
|
| MD5 |
e9d05478043c89a02c34e7f789f8d4e6
|
|
| BLAKE2b-256 |
7c3ebd1fe6308cc3abc21b61000db922405b0dc836b0d36082fb794738a01a32
|
Provenance
The following attestation bundles were made for disgust_docs-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on LebedAlIv2601/shareable-ai-md-docs
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
disgust_docs-0.1.0-py3-none-any.whl -
Subject digest:
1ada73f60f4b1be557e47f5c743805b5cf47dd297b403852a6b6db08c8f62a66 - Sigstore transparency entry: 2107802350
- Sigstore integration time:
-
Permalink:
LebedAlIv2601/shareable-ai-md-docs@23b09cf6fb0cdae1bc2f0484d04b3e713fb4f424 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/LebedAlIv2601
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@23b09cf6fb0cdae1bc2f0484d04b3e713fb4f424 -
Trigger Event:
push
-
Statement type: