click-skeleton

Tools	Result
Coverage

Description

Library to build a CLI with a well defined skeleton and helpers, including :

completion
real –help eagerness
help and version colors
readme generation
-V / –version / version subcommand
-h / –help / help subcommand
subgroup creation and registering made easier

EXAMPLE CLI

Commands

Usage: example-cli [OPTIONS] COMMAND [ARGS]...

  Simple CLI example

Options:
  --global-example TEXT  A global option
  --option-one TEXT      First option
  --option-two TEXT      Second option
  -V, --version          Show the version and exit.
  -h, --help             Show this message and exit.

Commands:
  abort                      Generates an exception
  expanded-path              Expand option path
  help                       Print help
  readme (doc)               Generates a README.rst
  subgroup (subgroup-alias)  A sub group
  version                    Print version

example-cli abort

Usage: example-cli abort [OPTIONS]

  Generates an exception on purpose (test)

Options:
  -h, --help  Show this message and exit.

example-cli expanded-path

Usage: example-cli expanded-path [OPTIONS]

  Command with expanded path option

Options:
  --file PATH  File path which expands
  -h, --help   Show this message and exit.

example-cli help

Usage: example-cli help [OPTIONS]

  Print help

Options:
  -h, --help  Show this message and exit.

example-cli readme

Usage: example-cli readme [OPTIONS]

  Uses gen_doc click-skeleton helper to generates a complete readme

Options:
  --output [rst|markdown]  README output format  [default: rst]
  -h, --help               Show this message and exit.

example-cli subgroup

Usage: example-cli subgroup [OPTIONS] COMMAND [ARGS]...

  I am a subgroup!

Options:
  -h, --help  Show this message and exit.

Commands:
  help        Print help
  subcommand  A sub command

example-cli subgroup subcommand

Usage: example-cli subgroup subcommand [OPTIONS]

  I am a subcommand!

Options:
  --myoptions TEXT  A splitted option
  -h, --help        Show this message and exit.

example-cli version

Usage: example-cli version [OPTIONS]

  Print version, equivalent to -V and --version

Options:
  -h, --help  Show this message and exit.

Release files for click-skeleton 0.33.1

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

Source distribution (sdist)

Source distribution for click-skeleton 0.33.1
File	Size	Uploaded
click_skeleton-0.33.1.tar.gz	43.4 kB	May 24, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for click-skeleton 0.33.1
File	Interpreter	ABI	Platform	Reset
click_skeleton-0.33.1-py3-none-any.whl 16.9 kB May 24, 2025	Python 3	none	any	Details

Total release size: 60.3 kB

Release files / click_skeleton-0.33.1.tar.gz

Download URL	click_skeleton-0.33.1.tar.gz
Size	43.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`d550de0039e0d4bb212d049e6bbd1c1b9de0f03eb36e8e806300c174498eebfb`
BLAKE2b-256 checksum How to use checksums	`61ad9f414dcc93ddad68fe1101ce9eb3a49c7b9cf34eed6d3ee1132f09b58c74`
Upload date	May 24, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.8`

Release files / click_skeleton-0.33.1-py3-none-any.whl

Download URL	click_skeleton-0.33.1-py3-none-any.whl
Size	16.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`89f19fb180c27ccc7c2db29564fdd58a41cfb28ff74131949d48f6c1a88a94cf`
BLAKE2b-256 checksum How to use checksums	`faebf8c7c76976be32193b7a9d2ad8f4cfeef03ce81f6a1d8219158b2d129cb8`
Upload date	May 24, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.7.8`