Skip to main content

Azure CLI Interactive Shell

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

Running

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

$ . dev_setup.py

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

0.4.5

  • Minor fixes

0.4.4

  • Minor fixes

0.4.3

  • Minor fixes

0.4.2

  • Fix incompatibility with Interactive extension installed through azdev.

0.4.1

  • Minor fixes

0.4.0

  • Interactive now installs the ‘interactive’ extension, which will allow for faster updates and support.

0.3.31

  • Ensure global subscription parameter appears in parameters.

0.3.30

  • Fix error found on windows where commands fail to run properly.

0.3.29

  • Fix command loading problem in interactive that was caused by deprecated objects.

0.3.28

  • Minor fixes

0.3.27

  • Minor fixes

0.3.26

  • Minor fixes

0.3.25

  • Update PyYAML dependency to 4.2b4

0.3.24

  • Minor fixes

0.3.23

  • Minor fixes

0.3.22

  • Fix dependency versions.

0.3.21

  • Mute logging from parser for completions.

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

0.3.20

  • 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.

0.3.19

  • 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

0.3.18

  • 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.

0.3.17

  • 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

0.3.16

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

  • Fixed regression with missing parameter completions.

0.3.15

  • Fixed issue where command option completions no longer appeared.

0.3.14

  • Clean up unused test files

0.3.13

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

  • Fix errors on start up

  • Fix some commands not running in interactive mode

0.3.12

  • Update for CLI core changes.

0.3.11

  • 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

  • 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’

0.2.1

  • CLI Performance changes integrated

0.2.0

  • Public Preview release

0.1.1

  • Preview release

Release files for azure-cli-interactive 0.4.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for azure-cli-interactive 0.4.5
File Size Uploaded
azure-cli-interactive-0.4.5.tar.gz 7.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for azure-cli-interactive 0.4.5
File Interpreter ABI Platform
azure_cli_interactive-0.4.5-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 14.9 kB

Release files / azure-cli-interactive-0.4.5.tar.gz

Download URL azure-cli-interactive-0.4.5.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
bf265d5ca7d0c3d9b79927b76a8bca6096facac92b733ebe27bbba8bfde1c422
BLAKE2b-256 checksum
How to use checksums
24f8b734f3d53b5318a9bbbc94a9e00bc2b2d2516a7d4a0881370bb5ec8a44af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Release files / azure_cli_interactive-0.4.5-py2.py3-none-any.whl

Download URL azure_cli_interactive-0.4.5-py2.py3-none-any.whl
Size 7.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
9b5c518d132ebe8ba5db1b1c4c28231be57d653de4e316fba853e1afaad6f33e
BLAKE2b-256 checksum
How to use checksums
315db8d0d2f15d76765749e8de4e5d47e8904ab11c08a473a57378258400e5a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Release history Release notifications | RSS feed

This release

0.4.5 This release

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.31

2 release files

0.3.30

2 release files

0.3.28

2 release files

0.3.27

2 release files

0.3.26

2 release files

0.3.23

2 release files

0.3.21

2 release files

0.3.19

2 release files

0.3.18

2 release files

0.3.17

2 release files

0.3.16

2 release files

0.3.15

2 release files

0.3.13

2 release files

0.3.11

2 release files

0.3.10

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page