Skip to content

feat(cli): enable shell completion for bash/zsh/fish#178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ulises-jeremias merged 1 commit into from
Jul 16, 2026
Merged

feat(cli): enable shell completion for bash/zsh/fish #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,13 @@ uv sync
uv run create-awesome-python-app --help
```

### Shell completion

```bash
create-awesome-python-app --install-completion # bash / zsh / fish
create-awesome-python-app --show-completion # print script only
```

## License

MIT — see [LICENSE](./LICENSE).
Expand Down
15 changes: 15 additions & 0 deletions packages/create-awesome-python-app/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,3 +9,18 @@ uv run create-awesome-python-app --help
uvx create-awesome-python-app@latest my-app # after PyPI publish
pipx run create-awesome-python-app my-app
```

## Shell completion

Typer installs completion scripts for bash, zsh, and fish:

```bash
# Interactive install into your shell profile
create-awesome-python-app --install-completion

# Or print the script and source it manually
create-awesome-python-app --show-completion
```

After installing, restart the shell (or `source` your profile) and tab-complete
flags such as `--template`, `--addons`, and `cache` subcommands.
2 changes: 1 addition & 1 deletion packages/create-awesome-python-app/src/create_awesome_python_app/cli.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
name="create-awesome-python-app",
help="Composable scaffolding CLI for production-ready Python apps.",
no_args_is_help=False,
add_completion=False,
add_completion=True,
)
cache_app = typer.Typer(help="Inspect and manage the local template cache")
app.add_typer(cache_app, name="cache")
Expand Down
2 changes: 2 additions & 0 deletions packages/create-awesome-python-app/tests/test_flags.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,5 +23,7 @@ def test_help_lists_scaffold_flags() -> None:
"--set",
"--force",
"--no-install",
"--install-completion",
"--show-completion",
]:
assert flag in text
Loading