Skip to main content

Microsoft Azure Command-Line Interactive Shell

Project description

The interactive shell for Microsoft Azure CLI (Command Line Interface)

  • Interactive Tutorials

  • Lightweight Drop Down Completions

  • Auto Cached Suggestions

  • Dynamic parameter completion

  • Defaulting scopes of commands

  • On the fly descriptions of the commands AND parameters

  • On the fly examples of how to utilize each command

  • Optional “az” component

  • Query the previous command

  • Navigation of example pane

  • Optional layout configurations

  • Fun Colors


To start the application

$ az shell

Then type your commands and hit [Enter]

To use commands outside the application

$ #[command]

To Search through the last command as json jmespath format for querying

$ ? [param]

Note: Only if the previous command dumps out json, e.g. vm list

To only see the commands for a command

$ %% [top-level command] [sub-level command] etc

To undefault a value

$ %% ..

Use Examples

Type a command, for example:

$ vm create

Look at the examples

Scroll through the pane with Control Y for up and Control N for down #

Pick the example you want with:

$ vm create :: [Example Number]

Dev Setup

Fork and clone repository

$ .

To get the Exit Code of the previous command:

$ $

Clear History

Only clears the appended suggestion when you restart the shell

$ clear-history

Release History


  • Update PyYAML dependency to 4.2b4


  • Minor fixes


  • Minor fixes


  • Cap the dependencies


  • Mute logging from parser for completions.

  • Made interactive more resistant to stale/corrupted help caches.


  • Allow interactive completers to function with positional arguments.

  • More user-friendly output when users type ‘'.

  • Fix completions for parameters with no help.

  • Fix descriptions for command-groups.


  • Stops completions upon unrecognized commands.

  • Add event hooks before and after command subtree is created.

  • Allow completions for –ids parameters.

  • sdist is now compatible with wheel 0.31.0


  • Completions kick in as soon as command table loading is done.

  • Fix bug with using –style parameter.

  • Interactive lexer instantiated after command table dump if missing.

  • Improvements to completer support.


  • Persist history across different sessions

  • Fixed history while in scope

  • Updates to interactive telemetry

  • Fixed progress meter for long running operations

  • Completions more robust to command table exceptions


  • Fix issue where user is prompted to login when using interactive mode in Cloud Shell.

  • Fixed regression with missing parameter completions.


  • Fixed issue where command option completions no longer appeared.


  • Clean up unused test files


  • Fix issue where interactive would not start on Python 2.

  • Fix errors on start up

  • Fix some commands not running in interactive mode


  • Update for CLI core changes.


  • minor fixes

0.3.10 (2017-09-22)

  • minor fixes

0.3.9 (2017-08-31)

  • minor fixes

0.3.8 (2017-08-28)

  • minor fixes

0.3.7 (2017-07-27)

  • Improves the start up time by using cached commands

0.3.7 (2017-07-27)

  • Increase test coverage

0.3.5 (2017-06-21)

  • Enhance the ‘?’ gesture to also inject into the next command

0.3.4 (2017-06-13)

  • Fixes Interactive errors with the profile 2017-03-09-profile-preview (#3587)

  • Allows ‘–version’ as a parameter for interactive mode (#3645)

  • Stop Interactive Mode from Throwing errors from Validation completions (#3570)

  • Progress Reporting for template deployments (#3510)

0.3.3 (2017-05-30)

  • –progress flag

  • Removed –debug and –verbose from completions

0.3.2 (2017-05-18)

  • Bug fixes.

  • Remove ‘interactive’ from completions (#3324)

0.3.1 (2017-05-09)

  • Add link to blog in ‘az interactive —help’ (#3252)

0.3.0 (2017-05-05)

  • Integrate interactive into az

  • Colors Options

  • Rename ‘shell’ => ‘interactive’


  • CLI Performance changes integrated


  • Public Preview release


  • Preview release

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-cli-interactive-0.3.25.tar.gz (27.8 kB view hashes)

Uploaded Source

Built Distribution

azure_cli_interactive-0.3.25-py2.py3-none-any.whl (36.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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