diff --git a/README.md b/README.md index b7a8c77..8627c1d 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,28 @@ This repository contains a Dockerfile for building an Azure CLI container image. It is designed to be used as a operating environment for running Azure CLI commands, -while providing isolation from the host system. User's home directory is mounted -into the container to persist configuration and credentials. Volume is used to +while providing isolation from the host system. Volume is used to persist home directory data. ## Usage -```bash -azure-cli [--account ACCOUNT_NAME] [--user CONTAINER_USERNAME] [ container CLI arguments... ] +```text +azure-cli (-l|--list) ``` -- `--account ACCOUNT_NAME` - Specify the account name to use for the volume that stores the home directory data. Defaults to the current user's username. -- `--user CONTAINER_USERNAME` - Specify the username to use inside the container. Defaults `ubuntu`. -- `container CLI arguments...` - Any additional arguments are passed to the container CLI command (not the command inside the container). +List all containers created by this script. -> **Note:** Copy the `azure-cli` script to a directory in your `PATH` (e.g. `/usr/local/bin`) to use it as a regular command. +```text +azure-cli [(-a|--account) ] + [--user ] + [--name ] + [--volume :] + [--] + [ other arguments passed as a command to execute inside the container ] +``` + +- '--account ': Specifies the account name to be set as an environment variable inside the container. The volume name will be derived from this account name. +- '--user ': Specifies the user name to be used inside the container. Default is 'ubuntu'. +- '--name ': Specifies the name of the container. Default is sanitized account name. +- '--volume :': Binds additional local path to a path inside the container. +- '--': Indicates the end of options for the script. Any arguments following this will be passed as a command to execute inside the container.