alai-doc
alai-doc shows the documentation of a plugin or role in an Ansible collection without a browser. The docs open in a viewer on a terminal, and are printed as Markdown anywhere else.
Preview: alai-doc is released in preview, as a 0.x version under semantic versioning. The viewer and the command line can still change as they're worked out, so a release that breaks something bumps the minor version, from 0.1 to 0.2, and lists the change in the changelog. A patch release, such as 0.1.1, only fixes bugs.
$ alai-doc ansible.builtin.copy
$ alai-doc win_copy --output-format markdown
Installing
alai-doc is published on PyPI, and
installs alai with it. When it's used often, uv
can install it as a tool so alai-doc is on the PATH.
$ uv tool install alai-doc
The documentation covers finding a plugin, the viewer's keys and every option.
Developing
It is built and checked with uv.
$ uv sync
$ uv run tox run -f sanity
$ uv run tox run -f py314
The docs at alai.sh/alai-doc are built from
docs/ with uv run tox run -e docs. The build also writes the CLI
reference and records the terminal recordings with
cli-recorder, so it needs Linux
or macOS.
Not done yet
- Finding a plugin from the viewer, keyboard links, picking from part of a name or a glob, and Tab completion.
License
MIT, see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for alai-doc 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| alai_doc-0.1.0.tar.gz | 45.0 kB | With provenance | Details for alai_doc-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| alai_doc-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for alai_doc-0.1.0-py3-none-any.whl |
Total release size: 92.5 kB
Release files / alai_doc-0.1.0.tar.gz
| Download URL | alai_doc-0.1.0.tar.gz |
|---|---|
| Size | 45.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
656fec78a6c68a4ba90d21182db78146ddc6e5fb8b79688d9cadfbac8565a3bf
|
|
BLAKE2b-256 checksum How to use checksums |
b346b99f66ea7057392545f8ba6c9f07e9c9130085feb7240bf7aad90e480a5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.
Transparency logRelease files / alai_doc-0.1.0-py3-none-any.whl
| Download URL | alai_doc-0.1.0-py3-none-any.whl |
|---|---|
| Size | 47.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4f9324be4b11c84a849c224557c09216cab49c5faf523086228abb6a831c27e0
|
|
BLAKE2b-256 checksum How to use checksums |
b3986219a29c3b001a7c3412bdb1d0451fb32648188decdb154b27d257fd2df2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.
Transparency logSecurity for alai-doc 0.1.0
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for alai_doc-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.
Transparency logA 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.
