Autogenerate for click cli projects
Go to file
jpk 6abe651e76 Fix #1 incomplete usage descriptions 2023-08-18 15:50:33 +02:00
clickusagelib Add updated usage to commit to be pushed 2023-08-15 13:35:19 +02:00
.gitignore Add .gitignore 2022-07-18 22:48:35 +02:00
.pre-commit-config.yaml Initial commit. 2022-07-15 11:23:45 +02:00 Update url 2023-08-15 13:05:15 +02:00 Updated 2023-08-15 13:35:46 +02:00 Fix #1 incomplete usage descriptions 2023-08-18 15:50:33 +02:00
poetry.lock clickusagemd searches for git root to locate pyproject.yaml 2022-08-11 11:56:06 +02:00
pyproject.toml Fix #1 incomplete usage descriptions 2023-08-18 15:50:33 +02:00

Click Usage Markdown Generator


Add clickusagemd as development dependency to your Poetry project.

poetry add -D git+

By adding a revision tag you can stay on a — at least for you — working version, instead of working with the latest and possible broken commit.

The latest recommended revision is: 0.8.2.

To install:

poetry add -D git+

After installing, register the pre-push hook. The hook is installed by executing the command poetry run clickusagemd install. If an previous, untagged version of the pre-push hook was installed you might need to manually delete the file .git/hooks/pre-push before installing. Later versions of clickusagemd will detect its own pre-hook files and will install or update them.


To update clickusagemd either run

poetry update clickusagemd

with , or to update all Poetry dependencies at once

poetry update




Clickusagemd can be uninstalled by removing the pre-push hook with

poetry run clickusagemd uninstall

or by manually deleting the file .git/hooks/pre-push.

To completely remove the clickusagemd command use the Poetry package manager to remove the dependency.

poetry remove -D clickusagemd