From a0b5c5542f1c45322210c1b3f369a6770c373425 Mon Sep 17 00:00:00 2001 From: danielcristho Date: Mon, 26 Jan 2026 17:42:30 +0700 Subject: [PATCH 1/3] docs: add shell completion --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index a05e46b..0e0c76d 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,36 @@ dependencies = [ ] ``` +## Shell Completion + +The Render Engine CLI supports tab completion for bash, zsh, and fish shells. This feature helps you quickly complete commands, options, and arguments. + +### Bash + +Add this to your `~/.bashrc`: + +```bash +eval "$(_RENDER_ENGINE_COMPLETE=bash_source render-engine)" +``` + +### Zsh + +Add this to your `~/.zshrc`: + +```zsh +eval "$(_RENDER_ENGINE_COMPLETE=zsh_source render-engine)" +``` + +### Fish + +Add this to your `~/.config/fish/completions/render-engine.fish`: + +```fish +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) From 32526a0c20229af58a2080a93f7041275595e0cb Mon Sep 17 00:00:00 2001 From: danielcristho Date: Tue, 27 Jan 2026 04:44:26 +0700 Subject: [PATCH 2/3] docs: add shell completion --- README.md | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0e0c76d..f68b688 100644 --- a/README.md +++ b/README.md @@ -48,31 +48,33 @@ dependencies = [ ## Shell Completion -The Render Engine CLI supports tab completion for bash, zsh, and fish shells. This feature helps you quickly complete commands, options, and arguments. +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 +- **Bash** -Add this to your `~/.bashrc`: + Add this to your `~/.bashrc`: -```bash -eval "$(_RENDER_ENGINE_COMPLETE=bash_source render-engine)" -``` + ```bash + eval "$(_RENDER_ENGINE_COMPLETE=bash_source render-engine)" + ``` -### Zsh +- **Zsh** -Add this to your `~/.zshrc`: + Add this to your `~/.zshrc`: -```zsh -eval "$(_RENDER_ENGINE_COMPLETE=zsh_source render-engine)" -``` + ```zsh + eval "$(_RENDER_ENGINE_COMPLETE=zsh_source render-engine)" + ``` -### Fish +- **Fish** -Add this to your `~/.config/fish/completions/render-engine.fish`: + Add this to your `~/.config/fish/completions/render-engine.fish`: -```fish -eval (env _RENDER_ENGINE_COMPLETE=fish_source render-engine) -``` + ```fish + 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. From 050ccba4a60438c8a787f538c5c1492c05bee4fb Mon Sep 17 00:00:00 2001 From: danielcristho Date: Wed, 28 Jan 2026 11:33:14 +0700 Subject: [PATCH 3/3] docs: replace text bold with h3 --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f68b688..475e5bd 100644 --- a/README.md +++ b/README.md @@ -52,29 +52,29 @@ For a smoother CLI experience, Render Engine CLI provides built-in shell complet for `bash`, `zsh`, and `fish`. This allows you to quickly autocomplete commands, options, and arguments directly in your terminal. -- **Bash** +### Bash - Add this to your `~/.bashrc`: +Add this to your `~/.bashrc`: - ```bash - eval "$(_RENDER_ENGINE_COMPLETE=bash_source render-engine)" - ``` +```sh +eval "$(_RENDER_ENGINE_COMPLETE=bash_source render-engine)" +``` -- **Zsh** +### Zsh - Add this to your `~/.zshrc`: +Add this to your `~/.zshrc`: - ```zsh - eval "$(_RENDER_ENGINE_COMPLETE=zsh_source render-engine)" - ``` +```sh +eval "$(_RENDER_ENGINE_COMPLETE=zsh_source render-engine)" +``` -- **Fish** +### Fish - Add this to your `~/.config/fish/completions/render-engine.fish`: +Add this to your `~/.config/fish/completions/render-engine.fish`: - ```fish - eval (env _RENDER_ENGINE_COMPLETE=fish_source render-engine) - ``` +```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.