Skip to content

Commit 141f136

Browse files
authored
Merge pull request #36 from danielcristho/main
2 parents 9b51868 + 050ccba commit 141f136

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,38 @@ dependencies = [
4646
]
4747
```
4848

49+
## Shell Completion
50+
51+
For a smoother CLI experience, Render Engine CLI provides built-in shell completion
52+
for `bash`, `zsh`, and `fish`. This allows you to quickly autocomplete commands, options,
53+
and arguments directly in your terminal.
54+
55+
### Bash
56+
57+
Add this to your `~/.bashrc`:
58+
59+
```sh
60+
eval "$(_RENDER_ENGINE_COMPLETE=bash_source render-engine)"
61+
```
62+
63+
### Zsh
64+
65+
Add this to your `~/.zshrc`:
66+
67+
```sh
68+
eval "$(_RENDER_ENGINE_COMPLETE=zsh_source render-engine)"
69+
```
70+
71+
### Fish
72+
73+
Add this to your `~/.config/fish/completions/render-engine.fish`:
74+
75+
```sh
76+
eval (env _RENDER_ENGINE_COMPLETE=fish_source render-engine)
77+
```
78+
79+
After adding the appropriate line to your shell configuration file, restart your shell or source the configuration file to enable completion.
80+
4981
## Getting Started
5082

5183
Check out the [Getting Started](https://render-engine.readthedocs.io/en/latest/page/) Section in the [Documentation](https://render-engine.readthedocs.io)

0 commit comments

Comments
 (0)