Codestin Search App

rickwporter · 2025-01-08T02:03:07Z

Rationale

When creating complex CLI programs, it is useful to see all the options available from/below a command.

Changes

Add Typer(command_tree=False) parameter to the constructor. When command_tree=True, there is a --show-sub-commands option available to see all the commands below the current one.

Example

See tests/assets/subcommand_tree.py for code. Here's an example of the output:

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py --help
                                                                                                
 Usage: subcommand_tree.py [OPTIONS] COMMAND [ARGS]...                                          
                                                                                                
 Random help                                                                                    
                                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
│ --show-sub-commands           Show sub-command tree                                          │
│ --install-completion          Install completion for the current shell.                      │
│ --show-completion             Show completion for the current shell, to copy it or customize │
│                               the installation.                                              │
│ --help                        Show this message and exit.                                    │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────╮
│ version   Print CLI version and exit                                                         │
│ users     Manage users                                                                       │
│ pets                                                                                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py --show-sub-commands
╭─ Sub-Commands ───────────────────────────────────────────────────────────────────────────────╮
│ version*                       Print CLI version and exit                                    │
│ users                          Manage users                                                  │
│   add*                         Short help                                                    │
│   delete*                                                                                    │
│   update                       Update user info                                              │
│     name*                      change name                                                   │
│     address*                   change address                                                │
│ pets                                                                                         │
│   add*                         add pet                                                       │
│   list*                                                                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
* denotes commands without subcommands
(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py version
My CLI Version 1.0
(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py version --help
                                                                                                
 Usage: subcommand_tree.py version [OPTIONS]                                                    
                                                                                                
 Print CLI version and exit                                                                     
                                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                  │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py users --help
                                                                                                
 Usage: subcommand_tree.py users [OPTIONS] COMMAND [ARGS]...                                    
                                                                                                
 Manage users                                                                                   
                                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
│ --show-sub-commands          Show sub-command tree                                           │
│ --help                       Show this message and exit.                                     │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────╮
│ add      Short help                                                                          │
│ delete                                                                                       │
│ update   Update user info                                                                    │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py users --show-sub-commands
╭─ Sub-Commands ───────────────────────────────────────────────────────────────────────────────╮
│ add*                                  Short help                                             │
│ delete*                                                                                      │
│ update                                Update user info                                       │
│   name*                               change name                                            │
│   address*                            change address                                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
* denotes commands without subcommands
(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py users update --show-sub-commands
╭─ Sub-Commands ───────────────────────────────────────────────────────────────────────────────╮
│ name*                               change name                                              │
│ address*                            change address                                           │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
* denotes commands without subcommands
(.venv) ~/typer-rickwporter/tests/assets>

github-actions · 2025-09-20T07:55:52Z

This pull request has a merge conflict that needs to be resolved.

github-actions · 2025-12-24T23:25:38Z

This pull request has a merge conflict that needs to be resolved.

github-actions · 2025-12-25T09:53:38Z

This pull request has a merge conflict that needs to be resolved.

github-actions · 2026-02-10T19:33:03Z

This pull request has a merge conflict that needs to be resolved.

rickwporter and others added 2 commits January 7, 2025 20:40

Add ability to show sub-commands

7f23704

Merge branch 'master' into sub-command-tree

0ce09f1

rickwporter marked this pull request as ready for review January 8, 2025 02:10

svlandeg added the feature New feature, enhancement or request label Jan 8, 2025

rickwporter and others added 3 commits January 9, 2025 18:51

Merge branch 'master' into sub-command-tree

320dc61

Fix Literal typing issue for Python 3.7

50fd088

Merge branch 'master' into sub-command-tree

57688b2

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Sep 20, 2025

Merge branch 'master' into sub-command-tree

7ef2d7a

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Sep 20, 2025

rickwporter and others added 5 commits September 22, 2025 16:48

Fix some import issues with rich

8959509

Merge branch 'master' into sub-command-tree

ba96bf6

Use lazy loading of rich_utils, and rich variables from core

5c8c4ac

Merge branch 'master' into sub-command-tree

61a28ac

Merge branch 'master' into sub-command-tree

7dfa8dd

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Oct 20, 2025

This comment was marked as resolved.

Sign in to view

Merge branch 'master' into sub-command-tree

d5c78f1

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Oct 20, 2025

Merge branch 'master' into sub-command-tree

3d0a5bf

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Dec 24, 2025

rickwporter and others added 2 commits December 24, 2025 21:57

Merge branch 'master' into sub-command-tree

9b51fb9

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

5936111

github-actions bot added conflicts Automatically generated when a PR has a merge conflict and removed conflicts Automatically generated when a PR has a merge conflict labels Dec 25, 2025

Merge branch 'master' into sub-command-tree

132dea9

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Dec 26, 2025

pre-commit-ci-lite bot and others added 2 commits December 26, 2025 12:29

🎨 Auto format

6a04f59

Use latest builtins

3d28d55

rickwporter force-pushed the sub-command-tree branch from 78d1a42 to 3d28d55 Compare December 26, 2025 12:50

rickwporter added 2 commits January 13, 2026 20:32

Merge branch 'master' into sub-command-tree

5eed30d

Merge branch 'master' into sub-command-tree

b966e6c

github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Feb 10, 2026

Merge branch 'master' into sub-command-tree

9a6094a

github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Feb 10, 2026

🎨 Auto format

ef8929a

rickwporter changed the title ~~✨ Add ability to show sub-commands~~ ✨ Add ability to show sub-command tree Feb 16, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

✨ Add ability to show sub-command tree#1115

✨ Add ability to show sub-command tree#1115
rickwporter wants to merge 22 commits intofastapi:masterfrom
rickwporter:sub-command-tree

rickwporter commented Jan 8, 2025

Uh oh!

github-actions bot commented Sep 20, 2025

Uh oh!

This comment was marked as resolved.

github-actions bot commented Dec 24, 2025

Uh oh!

github-actions bot commented Dec 25, 2025

Uh oh!

github-actions bot commented Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Comments

Conversation

rickwporter commented Jan 8, 2025

Rationale

Changes

Example

Uh oh!

github-actions bot commented Sep 20, 2025

Uh oh!

This comment was marked as resolved.

github-actions bot commented Dec 24, 2025

Uh oh!

github-actions bot commented Dec 25, 2025

Uh oh!

github-actions bot commented Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants