Skip to content

feat(cli): Add a subcommand to generate shell completions #74

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

Open
kunzaatko wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat(cli): Add a subcommand to generate shell completions #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed99acc
feat(cli): Add a subcommand to generate shell completions
kunzaatko Feb 13, 2026
358d15e
docs: Add note about shell-completions to the "getting started" section
kunzaatko Feb 14, 2026
edc147a
fix: Add the rust native completions and setup documentation
kunzaatko Feb 16, 2026
e9a6102
feat(clap): Add the shell-completions generation subcommand
kunzaatko Feb 16, 2026
6881f39
feat(cli): Add subcommand hints for value completions
kunzaatko Feb 16, 2026
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
140 changes: 127 additions & 13 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 10 additions & 9 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ notify-debouncer-full = "0.5.0"
owo-colors = { version = "4.1.0", features = ["supports-colors"] }
regex = "1.11.1"
rhai = { version = "1.21.0", features = [
"std",
"internals",
"no_custom_syntax",
"sync",
"std",
"internals",
"no_custom_syntax",
"sync",
], default-features = false }
tracing = "0.1.41"
rhai-autodocs = { version = "0.8.0", optional = true }
Expand All @@ -54,6 +54,7 @@ symlink = "0.1.0"
hex = "0.4.3"
walkdir = "2.5.0"
tracing-tree = "0.4.0"
clap_complete = { version = "4.5.66", features = ["unstable-dynamic"] }
# rhai-autodocs = { version = "0.7.0", path = "../../clones/rhai-autodocs" }

[dev-dependencies]
Expand All @@ -62,14 +63,14 @@ rstest = { version = "0.24.0", default-features = false }
# tracing-tree = "0.4.0"
assert_fs = "1.1.2"
insta = { version = "1.42.1", default-features = false, features = [
"colors",
"redactions",
"filters",
"colors",
"redactions",
"filters",
] }
predicates = "3.1.3"
test-log = { version = "0.2.17", default-features = false, features = [
"color",
"trace",
"color",
"trace",
] }
assert_cmd = "2.0.16"

Expand Down
29 changes: 29 additions & 0 deletions docs/src/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,35 @@ $ yolk init

This will create the yolk directory, with a default `yolk.rhai` file, and an `eggs` directory.

### Shell completions

`yolk` comes with built-in shell completions for `bash`, `zsh`, `fish`, `elvish` and `powershell`.
To enable those, for `bash` run
```bash
echo "source <(COMPLETE=bash yolk)" >> ~/.bashrc
```
for `zsh`, run
```zsh
echo "source <(COMPLETE=zsh yolk)" >> ~/.zshrc
```
for `fish` run
```fish
echo "COMPLETE=fish yolk | source" >> ~/.config/fish/completions/yolk.fish
```
for `elvish` run
```elvish
echo "eval (E:COMPLETE=elvish yolk | slurp)" >> ~/.elvish/rc.elv
```
and for `powershell` run
```powershell
echo '$env:COMPLETE = "powershell"; yolk | Out-String | Invoke-Expression; Remove-Item Env:\COMPLETE' >> $PROFILE
```

Static completions may also be generated using
```sh
yolk shell-completions <SHELL>
```

### Adding your first egg

let's say we want to manage the configuration for the `alacritty` terminal emulator.
Expand Down
Loading