mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-07 12:47:49 +00:00
4c3d8cf84f
* docs: updated commands documentation per issue 1429 and minor corrections, ran prettier * docs: updated commands documentation per issue 1429 and included pr 1560 feedback * docs: minor formatting and copyedits --------- Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com> Co-authored-by: Lorna Mitchell <lorna.mitchell@redocly.com>
64 lines
1.7 KiB
Markdown
64 lines
1.7 KiB
Markdown
# `completion`
|
|
|
|
## Introduction
|
|
|
|
The `completion` command generates the scripts to add autocompletion to your bash or zsh shell. This addition is a handy productivity boost if you regularly use `redocly` from the command line.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
redocly completion
|
|
```
|
|
|
|
The output is a script for you to copy and paste, and add to the configuration file for your shell. The instructions are in the comments of the output.
|
|
|
|
## Examples
|
|
|
|
### See bash shell example
|
|
|
|
To generate an autocompletion script, run the following command from a bash or zsh prompt:
|
|
|
|
```bash
|
|
redocly completion
|
|
```
|
|
|
|
If run from a bash prompt, the `completion` command outputs the following autocompletion script:
|
|
|
|
```sh
|
|
###-begin-redocly-completions-###
|
|
#
|
|
# yargs command completion script
|
|
#
|
|
# Installation: redocly completion >> ~/.bashrc
|
|
# or redocly completion >> ~/.bash_profile on OSX.
|
|
#
|
|
_redocly_yargs_completions()
|
|
{
|
|
local cur_word args type_list
|
|
|
|
cur_word="${COMP_WORDS[COMP_CWORD]}"
|
|
args=("${COMP_WORDS[@]}")
|
|
|
|
# ask yargs to generate completions.
|
|
type_list=$(redocly --get-yargs-completions "${args[@]}")
|
|
|
|
COMPREPLY=( $(compgen -W "${type_list}" -- ${cur_word}) )
|
|
|
|
# if no match was found, fall back to filename completion
|
|
if [ ${#COMPREPLY[@]} -eq 0 ]; then
|
|
COMPREPLY=()
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
complete -o default -F _redocly_yargs_completions redocly
|
|
###-end-redocly-completions-###
|
|
```
|
|
|
|
The installation instructions are included in the output as comments, showing how to run the command and add it to the correct file:
|
|
|
|
- `redocly completion >> ~/.bashrc`
|
|
- Or on OSX: `redocly completion >> ~/.bash_profile`
|
|
|
|
If you use zsh shell, the `completion` command provides a similar output that is appropriate for your system.
|