Skip to main content

An interactive Azure CLI 2.0 command line interface

Project description

An interactive Azure CLI 2.0 command line interface.

[Note] Microsoft official Azure CLI 2.0 shell can be found at Azure/azure-cli-shell


  • Auto-completion of Azure CLI group, subgroups, commands, and parameters

  • Syntax highlighting

  • Command history

Supported Environments

  • Python versions: 2.7, 3.3, 3.4, 3.5, 3.5, 3.6 and maybe more

  • OS: Mac, Ubuntu, CentOS, Bash-on-Windows, or any platform where azure-cli can be installed


You need Azure CLI 2.0 installed as prerequisites for azure-shell. Please refer to Install Azure CLI 2.0 and install it if not yet installed


The azure-shell requires python and pip to install. You can install the azure-shell using pip:

pip install azure-shell

If you’ve already have azure-shell installed and want to upgrade to the latest version, you can upgrade like this:

pip install --upgrade azure-shell


Once you’ve installed the azure-shell, you can run azure-shell by simply typing azure-shell:


You can exit the azure-shell by typing either exit or quit:

azure> exit

Basically you can run azure-shell without making any configurations but you can give options to azure-shell to change its default behabior:

azure-shell --help

Usage: azure-shell [-h] [--version] [--basedir BASEDIR] [--config CONFIG]
                   [--index INDEX]

An interactive Azure CLI command line interface

optional arguments:
  -h, --help         show this help message and exit
  --version          show program's version number and exit
  --basedir BASEDIR  Azure Shell base dir path ($HOME/.azureshell by default)
  --config CONFIG    Azure Shell config file path
                     ($HOME/.azureshell/azureshell.conf by default)
  --index INDEX      Azure Shell index file to load ($HOME/.azureshel/cli-

Azure Shell Index Generator

You can generate an index for azure-shell using azure-shell-index-generator command. Please be noted that it will take time before all data generation works are done

azure-shell-index-generator --output ~/.azureshell/cli-index.json

Basically you don’t need to generate the index by yourself as azure-shell automatically downloads an index from its repository and load it for commands and parameters completion in startup time. But you also can give azure-shell your index using –index option.

azure-shell --index ~/.azureshell/cli-index.json


Bug reports and pull requests are welcome on GitHub at

More Information

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

azure-shell-0.2.5.tar.gz (12.4 kB view hashes)

Uploaded source

Built Distribution

azure_shell-0.2.5-py2.py3-none-any.whl (17.4 kB view hashes)

Uploaded 3 5

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page