kaxil commented on a change in pull request #5789: [AIRFLOW-4222] Add cli autocomplete for bash & zsh URL: https://github.com/apache/airflow/pull/5789#discussion_r313358678
########## File path: docs/howto/cli-completion.rst ########## @@ -0,0 +1,42 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Set Up Bash/Zsh Completion +========================== + +When using bash (or ``zsh``) as your shell, ``airflow`` can use +`argcomplete <https://argcomplete.readthedocs.io/>`_ for auto-completion. + +For global activation of all argcomplete enabled python applications run: + +.. code-block:: bash + + sudo activate-global-python-argcomplete + +For permanent (but not global) airflow activation, use: + +.. code-block:: bash + + register-python-argcomplete airflow >> ~/.bashrc + +For one-time activation of argcomplete for airflow only, use: + +.. code-block:: bash + + eval "$(register-python-argcomplete airflow)" Review comment: Not sure as it would have to find out current Shell (bash/zsh - which might be easy) and then export that command to `.bash_rc` or `.bash_profile` or `.zshrc` etc by running some bash commands? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
