Portainer Command Line Interface

Deploy a Stack

  Usage: npx portainer stack deploy [options] <name>

  Options:

    --help                             output usage information
    -v, --verbose                      Enable verbose logging
    -u, --username <username>          Portainer username. Defaults to environment variable PORTAINER_USERNAME.
    -p, --password <password>          Portainer password. Defaults to environment variable PORTAINER_PASSWORD.
    -r, --url <url>                    Portainer URL, such as http://server:9000. Defaults to environment variable PORTAINER_URL.
    -k, --insecure                     Ignore certificate errors.
    -j, --json                         Format JSON.
    -c, --compose-file <compose_file>  Path to docker-compose.yml file. Defaults to ./docker-compose.yml.
    -P, --prune                        Prune obsolete or orphaned containers. Defaults to true.
    -W, --warning                      Add warning message to head of yaml. Defaults to true.

List Stacks

  Usage: npx portainer stack ls [options]

  Options:

    --help                     output usage information
    -v, --verbose              Enable verbose logging
    -u, --username <username>  Portainer username. Defaults to environment variable PORTAINER_USERNAME.
    -p, --password <password>  Portainer password. Defaults to environment variable PORTAINER_PASSWORD.
    -r, --url <url>            Portainer URL, such as http://server:9000. Defaults to environment variable PORTAINER_URL.
    -k, --insecure             Ignore certificate errors.
    -j, --json                 Format JSON.

Delete a Stack

  Usage: npx portainer stack rm [options] <name>

  Options:

    --help                     output usage information
    -v, --verbose              Enable verbose logging
    -u, --username <username>  Portainer username. Defaults to environment variable PORTAINER_USERNAME.
    -p, --password <password>  Portainer password. Defaults to environment variable PORTAINER_PASSWORD.
    -r, --url <url>            Portainer URL, such as http://server:9000. Defaults to environment variable PORTAINER_URL.
    -k, --insecure             Ignore certificate errors.
    -j, --json                 Format JSON.

List Endpoints

  Usage: npx portainer stack rm [options] <name>

  Options:

    --help                     output usage information
    -v, --verbose              Enable verbose logging
    -u, --username <username>  Portainer username. Defaults to environment variable PORTAINER_USERNAME.
    -p, --password <password>  Portainer password. Defaults to environment variable PORTAINER_PASSWORD.
    -r, --url <url>            Portainer URL, such as http://server:9000. Defaults to environment variable PORTAINER_URL.
    -k, --insecure             Ignore certificate errors.
    -j, --json                 Format JSON.