graphql-engine/docs/graphql/manual/hasura-cli/hasura_completion.rst
2018-10-12 09:30:25 +05:30

75 lines
1.8 KiB
ReStructuredText

.. _hasura_completion:
Hasura CLI: hasura completion
-----------------------------
Generate auto-completion code
Synopsis
~~~~~~~~
Output shell completion code for the specified shell (bash or zsh)
::
hasura completion [shell] [flags]
Examples
~~~~~~~~
::
# Bash
# Linux
# Add Bash completion file using:
$ sudo hasura completion bash --file=/etc/bash_completion.d/hasura
# Mac
# Install bash-completion using homebrew:
$ brew install bash-completion
# Add to your ~/.bash_profile:
if [ -f $(brew --prefix)/etc/bash_completion ]; then
. $(brew --prefix)/etc/bash_completion
fi
# Add the completion file:
$ sudo hasura completion bash --file=$(brew --prefix)/etc/bash_completion.d/hasura
# Windows (Git Bash)
# open git bash
$ mkdir -p ~/.bash_completion.d
# Add the completion file:
$ cd ~ && hasura completion bash --file=bash_completion.d/hasura
# Add the following to ~/.bash_profile
if [ -f ~/.bash_completion.d/hasura ]; then
. ~/.bash_completion.d/hasura
fi
# restart git bash
# Zsh (using oh-my-zsh)
$ mkdir -p $HOME/.oh-my-zsh/completions
$ hasura completion zsh --file=$HOME/.oh-my-zsh/completions/_hasura
# Reload the shell for the changes to take effect!
Options
~~~~~~~
::
--file string file to which output has to be written
-h, --help help for completion
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--project string hasura project directory where the commands should be executed. (default: current directory)
SEE ALSO
~~~~~~~~
* :ref:`hasura <hasura>` - hasura controls the hasura project
*Auto generated by spf13/cobra*