Skip to content
Merged
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,38 @@ dependencies = [
]
```

## Shell Completion

For a smoother CLI experience, Render Engine CLI provides built-in shell completion
for `bash`, `zsh`, and `fish`. This allows you to quickly autocomplete commands, options,
and arguments directly in your terminal.

### Bash

Add this to your `~/.bashrc`:

```sh
eval "$(_RENDER_ENGINE_COMPLETE=bash_source render-engine)"
```

### Zsh

Add this to your `~/.zshrc`:

```sh
eval "$(_RENDER_ENGINE_COMPLETE=zsh_source render-engine)"
```

### Fish

Add this to your `~/.config/fish/completions/render-engine.fish`:

```sh
eval (env _RENDER_ENGINE_COMPLETE=fish_source render-engine)
```

After adding the appropriate line to your shell configuration file, restart your shell or source the configuration file to enable completion.

## Getting Started

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