Skip to content

Update README.md #16

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
rsteube merged 1 commit into from
Nov 17, 2025
Merged

Update README.md #16

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ But these are not fully exposed to the shell and only accessible in [auto-prompt

Carapace-aws parses the [botocore] service definitions into a [carapace] based completer.
This enables support for descriptions, colored hightlighting, and custom completions.
Undefined completions are simply delegated to the official [aws_completer].
Undefined completions are then simply delegated to the official [aws_completer].

## Getting Started

When using [carapace-bin] `carapace-aws` is implicitly used when the binary is in [PATH].

Otherwise the completions can be loaded directly with [`carapace-aws _carapace`](https://carapace-sh.github.io/carapace/carapace/gen.html#hidden-subcommand).
Otherwise [source](https://carapace-sh.github.io/carapace/carapace/gen.html#hidden-subcommand) the output of `carapace-aws _carapace`.

[auto-prompt]:https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-prompting.html
[aws-cli]:https://github.com/aws/aws-cli
Expand Down