@nvax/portainer-deploy
v1.1.1
Published
Deploys a docker-compose.yml as a stack to a portainer instance
Downloads
4
Readme
partainer-deploy
A small CLI to deploy a docker-compose file to a Portainer instance.
Usage
$ npm install -g @nvax/portainer-deploy
$ portainer-deploy COMMAND
running command...
$ portainer-deploy (--version)
@nvax/portainer-deploy/1.1.1 linux-x64 node-v20.11.0
$ portainer-deploy --help [COMMAND]
USAGE
$ portainer-deploy COMMAND
...
Commands
portainer-deploy help [COMMANDS]
Display help for portainer-deploy.
USAGE
$ portainer-deploy help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for portainer-deploy.
See code: @oclif/plugin-help
portainer-deploy stack [FILE]
Deploys Docker Compose Files to Portainer
USAGE
$ portainer-deploy stack [FILE] --endpoint <value> --password <value> --stack <value> --url <value>
--username <value> [--env_link <value> | --envs <value>]
ARGUMENTS
FILE [default: docker-compose.yml] docker-compose file to deploy
FLAGS
--endpoint=<value> (required) portainer endpoint id
--env_link=<value> local variables to be sent to portainer stack, i.e.: "MY_ENV_VAR, MY_OTHER_ENV_VAR
--envs=<value> portainer env variables as json-array
--password=<value> (required) portainer password
--stack=<value> (required) portainer stack id
--url=<value> (required) portainer base url i.e.: https://portainer.example.com
--username=<value> (required) portainer username
DESCRIPTION
Deploys Docker Compose Files to Portainer
See code: src/commands/stack/index.ts