From 9c15e172eb5b50796eb050cc5704471bce09e024 Mon Sep 17 00:00:00 2001 From: "Danilo M." Date: Tue, 30 Jun 2026 15:09:34 +0200 Subject: help, completion: descriptive help text and bash completion Add group/leaf descriptions to argparse help and richer command help strings. Add generated bash completion (completions/firefly.bash) plus its generator (scripts/gen_completion.py), wired into the command checklist in CLAUDE.md and documented in the README. Bump to 0.2.1. Co-Authored-By: Claude Opus 4.8 --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index c63bad9..cf4eb4d 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,26 @@ pip install -e . Requires Python 3.11 or newer. No third-party runtime dependencies. +### Bash completion + +A completion script lives at `completions/firefly.bash`. Enable it by sourcing +it from your shell profile, or install it system-wide: + +```bash +# per-user: add to ~/.bashrc +source /path/to/firefly-cli/completions/firefly.bash + +# or system-wide +sudo cp completions/firefly.bash /usr/share/bash-completion/completions/firefly +``` + +It is generated from the command registry, never hand-edited. Regenerate after +adding or changing commands: + +```bash +python scripts/gen_completion.py > completions/firefly.bash +``` + ## Configuration Provide your Firefly III URL and a personal access token in either way: -- cgit v1.2.3