Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.12.4
Binary file added docs/_static/cli-help-annotated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,21 @@ Some standalone examples of Click applications are packaged with Click. They are
- [termui](https://github.com/pallets/click/tree/main/examples/termui) : A simple example that showcases terminal UI
helpers provided by click.

## Understanding the Help Output

Click automatically generates help pages for all commands. Each help page
contains several sections that describe the command's interface:

```{image} _static/cli-help-annotated.png
:alt: Annotated Click help output showing Usage, Description, Options, and Commands sections
:width: 720px
:align: center
```

The **Usage** line shows how to invoke the command. The **Options** section
lists all available flags and their descriptions. The **Commands** section
lists the subcommands available in a group.

## Basic Concepts - Creating a Command

Click is based on declaring commands through decorators. Internally, there is a non-decorator interface for advanced use
Expand Down
Loading
Loading