Skip to main content

clidocs

Human CLI help in the browser: renders a tool's docs with InSpectra

Usage

clidocs render semkit          # ~/Work/tools/docs/semkit/index.html, opened in the browser
clidocs render serp --no-open  # a tool without `docs` is rendered from `describe`

Mac only: needs dotnet (brew install dotnet) and InSpectra (dotnet tool install -g InSpectra.Gen; found on PATH or in ~/.dotnet/tools). DOTNET_ROOT defaults to Homebrew's /opt/homebrew/opt/dotnet/libexec. The tool is asked for describe --json first and for docs only when describe lists it, in an empty working directory — never a blind TOOL docs.

Development

uv sync
uv run clidocs --help
gate check                        # the full gate (run before every commit, on this machine)
uv run pytest --snapshot-update  # after changing a command's help; review tests/snapshots/help/

pytest fails below the coverage floor in pyproject.toml; ruff includes the security (S) rules; the gate also scans uv.lock for known vulnerabilities when osv-scanner is installed (brew install osv-scanner), and says it skipped the scan otherwise. The gate runs locally: [publish] gate_command in .agents/antagor/antagor.toml; no workflow runs it.

Release

The version is the git tag (vX.Y.Z) — pyproject.toml has no version =. Work goes through Antagor tickets (.agents/antagor/); a release (run by the Human) is

antagor publish --bump   # SemVer; at 0.x: patch = fix/feature, minor = breaking

It tags the release, builds CHANGELOG.md from the ticket titles and runs scripts/deploy.sh: push main with tags to origin. Nobody tags or pushes by hand.

Install

On this machine, from a local checkout:

uv tool install .

On any other machine (any OS), once this repo is pushed to GitHub — no PyPI publish needed:

uv tool install "rb-clidocs @ git+https://github.com/bolandeu/clidocs.git@vX.Y.Z"

Replace vX.Y.Z with the latest release tag (a tag cut by antagor publish; never install a branch). This is also how an AI agent bootstraps this CLI on a fresh machine/sandbox where it isn't installed yet — see src/rb_clidocs/data/SKILL.md.

Private repo? The command above is unchanged — uv runs git under the hood, so it authenticates the same way git clone does. On a machine where the install is refused with an auth error, do one of these once:

gh auth login          # interactive login also sets up git's credential helper
gh auth setup-git      # only needed if gh was logged in with --with-token / in CI

or use the SSH form instead of HTTPS:

uv tool install "rb-clidocs @ git+ssh://git@github.com/bolandeu/clidocs.git@vX.Y.Z"

Update an installed copy to the latest commit:

uv tool upgrade rb-clidocs

After install, the command clidocs is available globally, on macOS, Linux and Windows alike (see architecture.md in the cli-generator plugin for why: no shelling out, no hardcoded POSIX paths).

To pick up later architecture changes from the cli-generator template itself, run copier update in this repo (requires this repo and the template to both be git repos; see the cli-generator plugin's README).

Architecture

This project follows a fixed CLI architecture:

  • src/rb_clidocs/commands/ — argument parsing only, no business logic.
  • src/rb_clidocs/core/ — services, models, errors: the real logic.
  • src/rb_clidocs/providers/ — external APIs/integrations.
  • src/rb_clidocs/credentials/ — secrets via the OS keychain (keyring) and environment variables. Secrets never live in .rb_clidocs/config.toml.
  • src/rb_clidocs/output/ — human (rich) and --json rendering.

Run clidocs doctor to check environment/config/auth readiness, and clidocs --help for the full command surface. Every command supports --json for machine/agent consumption; errors are structured (error.code, fixed exit codes, error.action telling you what to do next) and go to stderr in human mode, so stdout is always safe to pipe.

A project can require a minimum CLI version in its .rb_clidocs/config.toml ([cli] min_version = "..."); an older install refuses with exit 6 and uv tool upgrade rb-clidocs fixes it.

See src/rb_clidocs/data/SKILL.md for the agent-facing usage guide bundled with this package — install it into an AI tool with clidocs skill install, or get it as plain text with clidocs --ai (works even without file access).

Metadata

Release files for rb-clidocs 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rb-clidocs 0.1.7
File Size Uploaded Provenance Actions
rb_clidocs-0.1.7.tar.gz 75.8 kB Without provenance Details for rb_clidocs-0.1.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rb-clidocs 0.1.7
File Interpreter ABI Platform Actions
rb_clidocs-0.1.7-py3-none-any.whl Python 3 none any Details for rb_clidocs-0.1.7-py3-none-any.whl

Total release size: 126.4 kB

Release files / rb_clidocs-0.1.7.tar.gz

Download URL rb_clidocs-0.1.7.tar.gz
Size 75.8 kB
Tags Source
SHA-256 checksum
How to use checksums
180e52e5bf92215cf908aeb72051d44debad6f3ed99cebc4abe0883e3568297d
BLAKE2b-256 checksum
How to use checksums
a8b225b32c6c68cac7dc513a0a01ca9bc4f610720dd5daad25f307b0f310b9d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / rb_clidocs-0.1.7-py3-none-any.whl

Download URL rb_clidocs-0.1.7-py3-none-any.whl
Size 50.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75694b0bcfdfc0cf088aef61f23157015799b7752dcb3f06bb56afeb995f0cf7
BLAKE2b-256 checksum
How to use checksums
36dc68b3dae06842d522ac1ff9f3a636b02518ebe611be3b4ae7830cbbfda8e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for rb-clidocs 0.1.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.7 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page