Appsody CLI
The Appsody command-line tool (CLI) enables the rapid development of cloud native applications.
Complete documentation is available at https://appsody.dev
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-h, --help help for appsody
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Build a local container image of your Appsody project.
Build a local container image of your Appsody project. The stack, along with your Appsody project, is extracted to a local directory before the container build is run.
By default, the built image is tagged with the project name that you specified when you initialised your Appsody project. If you did not specify a name, the image is tagged with the name of the root directory of your Appsody project.
If you want to push the built image to an image repository using the [--push] options, you must specify the relevant image tag.
Run this command from the root directory of your Appsody project.
appsody build [flags]
appsody build -t my-repo/nodejs-express --push
Builds the container image, tags it with my-repo/nodejs-express, and pushes it to the container registry the Docker CLI is currently logged into.
appsody build -t my-repo/nodejs-express:0.1 --push-url my-registry-url
Builds the container image, tags it with my-repo/nodejs-express, and pushes it to my-registry-url/my-repo/nodejs-express:0.1.
--buildah Build project using buildah primitives instead of Docker.
--buildah-options string Specify the buildah build options to use. Value must be in "".
--docker-options string Specify the Docker build options to use. Value must be in "". The following Docker options are not supported: '--help','-t','--tag','-f','--file'.
-f, --file string The file name to use for the deployment configuration. (default "app-deploy.yaml")
-h, --help help for build
--knative Deploy as a Knative Service
--pull-url string Remote repository to pull image from.
--push Push the container image to the image repository.
--push-url string The remote registry to push the image to. This will also trigger a push if the --push flag is not specified.
--stack-registry string Specify the URL of the registry that hosts your stack images. (default "docker.io")
-t, --tag string Container image name and optionally, a tag in the 'name:tag' format.
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Generate tab completions
Generate a completion script for Appsody to stdout. The default is bash, you can specify either 'bash' or 'zsh' as a parameter. Completion is optionally available for your convenience. It helps you fill out Appsody commands when you type the [TAB] key.
To install on macOS for bash completion
1. brew install bash-completion
2. Make sure to update your ~/.bash_profile as instructed.
3. appsody completion > /usr/local/etc/bash_completion.d/appsody
To install on Linux for bash completion
1. On a current Linux OS (in a non-minimal installation), bash completion should be available.
2. For Debian see the following link for more information: https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1.
3. Make sure to copy the appsody completion file generated above into the appropriate directory for your Linux distribution e.g.
appsody completion > /etc/bash_completion.d/appsody
For zsh,
The zsh shell must be enabled and .zshrc configured to run zsh completion.
To install Appsody zsh completion:
1. run appsody completion zsh > _appsody
2. copy _appsody to a directory in your $fpath
3. rm ~/.zcompdump*
appsody completion [flags]
-h, --help help for completion
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Debug your Appsody project.
Start a container-based continuous build environment for your Appsody project, with debugging enabled. Run this command from the root directory of your Appsody project.
appsody debug [flags]
appsody debug --docker-options "--privileged"
Starts the debugging environment, passing the "--privileged" option to the "docker run" command as a flag.
appsody debug --name my-project-dev2 -p 3001:3000
Starts the debugging environment, names the development container "my-project-dev2", and binds the container port 3000 to the host port 3001.
--docker-options string Specify the docker run options to use. Value must be in "". The following Docker options are not supported: '--help','-p','--publish-all','-P','-u','-—user','-—name','-—network','-t','-—tty,'—rm','—entrypoint', '--mount'.
-h, --help help for debug
-i, --interactive Attach STDIN to the container for interactive TTY mode
--name string Assign a name to your development container. (default "my-project")
--network string Specify the network for docker to use.
--no-watcher Disable file watching, regardless of container environment variable settings.
-p, --publish stringArray Publish the container's ports to the host. The stack's exposed ports will always be published, but you can publish addition ports or override the host ports with this option.
-P, --publish-all Publish all exposed ports to random ports
--stack-registry string Specify the URL of the registry that hosts your stack images. (default "docker.io")
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Build and deploy your Appsody project to Kubernetes.
Build and deploy a local container image of your Appsody project to your Kubernetes cluster. The command performs the following steps:
Run this command from the root directory of your Appsody project.
appsody deploy [flags]
appsody deploy --namespace my-namespace
Builds and deploys your project to the "my-namespace" namespace in your local Kubernetes cluster.
appsody deploy -t my-repo/nodejs-express --push-url external-registry-url --pull-url internal-registry-url
Builds and tags the image as "my-repo/nodejs-express", pushes the image to "external-registry-url/my-repo/nodejs-express", and creates a deployment manifest that tells the Kubernetes cluster to pull the image from "internal-registry-url/my-repo/nodejs-express".
--buildah Build project using buildah primitives instead of docker.
--buildah-options string Specify the buildah build options to use. Value must be in "".
--docker-options string Specify the docker build options to use. Value must be in "". The following Docker options are not supported: '--help','-t','--tag','-f','--file'.
-f, --file string The file name to use for the deployment manifest. (default "app-deploy.yaml")
--force DEPRECATED - Force the reuse of the deployment manifest file if one exists.
--generate-only Only generate the deployment manifest file. Do not deploy the project.
-h, --help help for deploy
--knative Deploy as a Knative Service
-n, --namespace string Target namespace in your Kubernetes cluster.
--no-build Deploys the application without building a new image or modifying the deployment manifest file.
--no-operator-check Do not check whether existing operators are already watching the namespace
--no-operator-install Deploy your application without installing the Appsody operator
--pull-url string Remote repository to pull image from.
--push Push this image to an external Docker registry. Assumes that you have previously successfully done docker login
--push-url string Remote repository to push image to. This will also trigger a push if the --push flag is not specified.
--stack-registry string Specify the URL of the registry that hosts your stack images. (default "docker.io")
-t, --tag string Docker image name and optionally a tag in the 'name:tag' format
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Delete your deployed Appsody project from a Kubernetes cluster.
Delete your deployed Appsody project from the configured Kubernetes cluster, using your existing deployment manifest.
By default, the command looks for the deployed project in the "default" namespace and uses the generated "app-deploy.yaml" deployment manifest, unless you specify otherwise.
Run this command from the root directory of your Appsody project.
appsody deploy delete [flags]
appsody deploy delete -f my-deploy.yaml
Deletes the AppsodyApplication from the "default" namespace, using the name and type specified in the "my-deploy.yaml" deployment manifest.
appsody deploy delete --namespace my-namespace
Deletes the AppsodyApplication from the "my-namespace" namespace, using the name and type specified in the "app-deploy.yaml" deployment manifest.
-h, --help help for delete
--buildah Build project using buildah primitives instead of docker.
--buildah-options string Specify the buildah build options to use. Value must be in "".
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--docker-options string Specify the docker build options to use. Value must be in "". The following Docker options are not supported: '--help','-t','--tag','-f','--file'.
--dryrun Shows the commands that are called by this command, without running them.
-f, --file string The file name to use for the deployment manifest. (default "app-deploy.yaml")
--force DEPRECATED - Force the reuse of the deployment manifest file if one exists.
--generate-only Only generate the deployment manifest file. Do not deploy the project.
--knative Deploy as a Knative Service
-n, --namespace string Target namespace in your Kubernetes cluster.
--no-build Deploys the application without building a new image or modifying the deployment manifest file.
--no-operator-check Do not check whether existing operators are already watching the namespace
--no-operator-install Deploy your application without installing the Appsody operator
--pull-url string Remote repository to pull image from.
--push Push this image to an external Docker registry. Assumes that you have previously successfully done docker login
--push-url string Remote repository to push image to. This will also trigger a push if the --push flag is not specified.
--stack-registry string Specify the URL of the registry that hosts your stack images. (default "docker.io")
-t, --tag string Docker image name and optionally a tag in the 'name:tag' format
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Extract your Appsody project to a local directory.
Extract the full application (the stack and your Appsody project) into a local directory. Your project is extracted into your local '$HOME/.appsody/extract' directory, unless you use the --target-dir flag to specify a different location.
Run this command from the root directory of your Appsody project.
appsody extract [flags]
appsody extract --target-dir $HOME/my-extract/directory
Extracts your project from the container to the local '$HOME/my-extract/directory' on your system.
--buildah Extract project using buildah primitives instead of Docker.
-h, --help help for extract
--name string Assign a name to your development container. (default "my-project-extract")
--target-dir string The absolute directory path to extract the files into. This directory must not exist, as it will be created.
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Initialize an Appsody project.
Set up the local Appsody development environment. You can do this for an existing project or use the template application provided by the stack.
By default, the command creates an Appsody stack configuration file and provides a simple default application. You can also initialize a project with a different template application, or no template.
To initialize a project with a template application, in a directory that is not empty, you need to specify the "overwrite" option [--overwrite]. Use 'appsody list' to see the available stacks and templates.
appsody init [stack] or [repository]/[stack] [template] [flags]
appsody init nodejs-express
Initializes a project with the default template from the "nodejs-express" stack in the default repository.
appsody init experimental/nodejs-functions
Initializes a project with the default template from the "nodejs-functions" stack in the "experimental" repository.
appsody init nodejs-express scaffold
Initializes a project with the "scaffold" template from "nodejs-express" stack in the default repository.
appsody init nodejs none
Initializes a project without a template for the "nodejs" stack in the default repository.
appsody init
Runs the stack init script to set up the local development environment on an existing Appsody project.
--application-name string Specifies the greater application which this project belongs to.
-h, --help help for init
--no-template Only create the .appsody-config.yaml file. Do not unzip the template project. [Deprecated]
--overwrite Download and extract the template project, overwriting existing files. This option is not intended to be used in Appsody project directories.
--project-name string Project Name for Kubernetes Service. (default "my-project")
--stack-registry string Specify the URL of the registry that hosts your stack images.
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
List the available Appsody stacks.
List all the Appsody stacks available in your repositories.
An asterisk in the repository column denotes the default repository. An asterisk in the template column denotes the default template that is used when you initialise an Appsody project.
appsody list [repository] [flags]
appsody list
Lists all available stacks for each of your repositories.
appsody list my-repo
Lists available stacks only in your "my-repo" repository.
-h, --help help for list
-o, --output string Output list in yaml or json format
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Install or uninstall the Appsody operator from your Kubernetes cluster.
This command allows you to "install" or "uninstall" the Appsody operator from the configured Kubernetes cluster. An installed Appsody operator is required to deploy your Appsody projects.
-h, --help help for operator
-n, --namespace string The namespace in which the operator will run. (default "default")
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Install the Appsody Operator.
Install the Appsody Operator into your configured Kubernetes cluster. The Appsody Operator listens for incoming AppsodyApplication resources on your cluster. For more information, see https://operatorhub.io/operator/appsody-operator.
By default, the operator watches a single namespace. You can specify the ‘--watch-all’ flag to tell the operator to watch all namespaces in the cluster. If you want to watch multiple, but not all, namespaces within your cluster, install an additional operator to watch each additional namespace.
appsody operator install [flags]
appsody operator install --namespace my-namespace --watchspace my-watchspace
Installs the Appsody Operator into your Kubernetes cluster in the "my-namespace" namespace, and sets it to watch for AppsodyApplication resources in the "my-watchspace" namespace.
-h, --help help for install
--no-operator-check Suppresses check for operator existing in namespace
--watch-all Specifies that the operator watches all namespaces.
-w, --watchspace string The namespace that the operator watches.
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-n, --namespace string The namespace in which the operator will run. (default "default")
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Uninstall the Appsody Operator.
Uninstall the Appsody Operator from your configured Kubernetes cluster.
appsody operator uninstall [flags]
appsody operator uninstall --namespace my-namespace
Uninstalls the Appsody Operator in the "my-namespace" namespace from your Kubernetes cluster.
--force Force removal of appsody apps if present
-h, --help help for uninstall
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-n, --namespace string The namespace in which the operator will run. (default "default")
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
List the Appsody containers running in the local Docker environment.
List all stack-based containers that are currently running in the local Docker environment. Shows the following information about the Appsody containers that are currently running: container ID, container name, image and status.
appsody ps [flags]
-h, --help help for ps
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Manage your Appsody repositories
Manage your Appsody repositories
-h, --help help for repo
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Add an Appsody repository.
Add an Appsody repository to your list of configured Appsody repositories.
appsody repo add <repository> <url> [flags]
appsody repo add my-local-repo file:///absolute/path/to/my-local-repo.yaml
Adds the "my-local-repo" repository, specified by the "file:///absolute/path/to/my-local-repo.yaml" file to your list of repositories.
-h, --help help for add
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
List your Appsody repositories.
List all your configured Appsody repositories. The "incubator" repository is the initial default repository for Appsody.
appsody repo list [flags]
-h, --help help for list
-o, --output string Output repo list in yaml or json format
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Remove an Appsody repository.
Remove an Appsody repository from your list of configured Appsody repositories. You cannot remove the default repository, but you can make a different repository the default (see appsody repo set-default).
appsody repo remove <repository> [flags]
appsody repo remove my-local-repo
Removes the "my-local-repo" repository from your list of configured repositories.
-h, --help help for remove
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Set a default repository.
Set your specified repository to be the default repository.
The default repository is used when you run the "appsody init" command without specifying a repository name. Use "appsody repo list" or "appsody list" to see which repository is currently the default (denoted by an asterisk).
appsody repo set-default <repository> [flags]
appsody repo set-default my-local-repo
Sets your default repository to "my-local-repo".
-h, --help help for set-default
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Run your Appsody project in a containerized development environment.
Run the local Appsody environment, starting a container-based, continuous build environment for your project. Run this command from the root directory of your Appsody project.
appsody run [flags]
appsody run
Runs your project in a containerized development environment.
appsody run --interactive
Runs your project in a containerized development environment, and attaches the standard input stream to the container. You can use the standard input stream to interact with processes inside the container.
appsody run -p 3001:3000 --docker-options "--privileged"
Runs your project in a containerized development environment, binds the container port 3000 to the host port 3001, and passes the "--privileged" option to the "docker run" command as a flag.
--docker-options string Specify the docker run options to use. Value must be in "". The following Docker options are not supported: '--help','-p','--publish-all','-P','-u','-—user','-—name','-—network','-t','-—tty,'—rm','—entrypoint', '--mount'.
-h, --help help for run
-i, --interactive Attach STDIN to the container for interactive TTY mode
--name string Assign a name to your development container. (default "my-project")
--network string Specify the network for docker to use.
--no-watcher Disable file watching, regardless of container environment variable settings.
-p, --publish stringArray Publish the container's ports to the host. The stack's exposed ports will always be published, but you can publish addition ports or override the host ports with this option.
-P, --publish-all Publish all exposed ports to random ports
--stack-registry string Specify the URL of the registry that hosts your stack images. (default "docker.io")
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Tools to help create and test Appsody stacks
Tools to help create and test Appsody stacks
-h, --help help for stack
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Add stack information into a production Appsody repository
Adds stack information into an Appsody repository. Adds stack information to a new or existing Appsody repository, specified by the <repository> argument. This enables you to share your stack with others. This command must be run after appsody stack package on the chosen stack.
The updated repository index file is created in ~/.appsody/stacks/dev.local directory.
Run this command from the root directory of your Appsody project.
appsody stack add-to-repo <repository> [flags]
appsody stack add-to-repo incubator
Creates a new repository index file for the incubator repository, setting the template URLs to begin with a default URL of https://github.com/appsody/stacks/releases/latest/download/
appsody stack add-to-repo myrepository --release-url https://github.com/mygitorg/myrepository/releases/latest/download/
Create a new index file for the myrepository repository, setting the template URLs to begin with https://github.com/mygitorg/myrepository/releases/latest/download/
appsody stack add-to-repo myrepository --release-url https://github.com/appsody/stacks/releases/latest/download/ --use-local-cache
Use an existing index for the myrepository repository or create it if it doesnt exist, setting the template URLs to begin with https://github.com/mygitorg/myrepository/releases/latest/download/
-h, --help help for add-to-repo
--release-url string URL to use within the repository to access the stack assets (default "https://github.com/appsody/stacks/releases/download/")
--use-local-cache Whether to use a local file if exists or create a new file
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Create a new Appsody stack.
Create a new Appsody stack, called <name>, in the current directory. You can use this stack as a starting point for developing your own Appsody stack.
By default, the new stack is based on the example stack: incubator/starter. If you want to use a different stack as the basis for your new stack, use the copy flag to specify the stack you want to use as the starting point. You can use 'appsody list' to see the available stacks.
The stack name must start with a lowercase letter, and can contain only lowercase letters, numbers, or dashes, and cannot end with a dash. The stack name cannot exceed 68 characters.
appsody stack create <name> [flags]
appsody stack create my-stack
Creates a stack called my-stack, based on the example stack “incubator/starter”.
appsody stack create my-stack --copy incubator/nodejs-express
Creates a stack called my-stack, based on the Node.js Express stack.
--copy string Copy the specified stack. The format is <repository>/<stack> (default "incubator/starter")
-h, --help help for create
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Check your stack structure.
Check that the structure of your stack is valid. Error messages indicate critical issues in your stack structure, such as missing files, directories, or stack variables. Warning messages suggest optional stack enhancements.
Run this command from the root directory of your stack, or specify the path to your stack.
appsody stack lint [path] [flags]
appsody stack lint
Checks the structure of the stack in the current directory"
appsody stack lint path/to/my-stack
Checks the structure of the stack "my-stack" in the path "path/to/my-stack"
-h, --help help for lint
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Package your stack.
Package your stack in a local Appsody development environment. You must run this command from the root directory of your stack.
The packaging process builds the stack image, generates the "tar.gz" archive files for each template, and adds your stack to the "dev.local" repository in your Appsody configuration. You can see the list of your packaged stacks by running 'appsody list dev.local'.
appsody stack package [flags]
appsody stack package
Packages the stack in the current directory, tags the built image with the default registry and namespace, and adds the stack to the "dev.local" repository.
appsody stack package --image-namespace my-namespace
Packages the stack in the current directory, tags the built image with the default registry and "my-namespace" namespace, and adds the stack to the "dev.local" repository.
appsody stack package --buildah --buildah-options "--format=docker"
Packages the stack in the current directory, builds project using buildah primitives in Docker format, tags the built image with the default registry and namespace, and adds the stack to the "dev.local" repository.
--buildah Build project using buildah primitives instead of Docker.
--buildah-options string Specify the buildah build options to use. Value must be in "".
--docker-options string Specify the Docker build options to use. Value must be in "". The following Docker options are not supported: '--help','-t','--tag','-f','--file'.
-h, --help help for package
--image-namespace string Namespace used for creating the images. (default "appsody")
--image-registry string Registry used for creating the images. (default "dev.local")
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Remove stack information from an Appsody repository
Removes stack information from an Appsody repository. Removes stack information, specified by <stack> from an Appsody repository, specified by the <repository> argument.
The updated repository index file is created in ~/.appsody/stacks/dev.local directory.
appsody stack remove-from-repo <repository> <stack> [flags]
appsody stack remove-from-repo incubator nodejs
Updates the repository index file for the incubator repository, removing the definition of the nodejs stack
-h, --help help for remove-from-repo
--use-local-cache Whether to use a local file if exists or create a new file
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Run validation tests against your stack and its templates.
Run validation tests against your stack and its templates, in your local Appsody development environment. Runs the following validation tests against the stack and its templates:
Run this command from the root directory of your Appsody project.
appsody stack validate [flags]
-h, --help help for validate
--image-namespace string Namespace used for creating the images. (default "appsody")
--image-registry string Registry used for creating the images. (default "dev.local")
--no-lint Skips running appsody stack lint
--no-package Skips running appsody stack package
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Stop the local, running Appsody container.
Stop the local, running Appsody container for your project.
By default, the command stops the Appsody container that was launched from the project in your current working directory. To see a list of all your running Appsody containers, run the command 'appsody ps'.
appsody stop [flags]
appsody stop
Stops the running Appsody container launched by the project in your current working directory.
appsody stop --name nodejs-express-dev
Stops the running Appsody container with the name "nodejs-express-dev".
-h, --help help for stop
--name string Assign a name to your development container. (default "my-project")
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Test your project in the local Appsody environment.
Run the local Appsody environment, starting a container-based, continuous build environment for your project, and running the test suite each time a file changes. Run this command from the root directory of your Appsody project.
appsody test [flags]
appsody test
Runs the tests for your Appsody project.
appsody test --no-watcher
Runs the tests for your Appsody project without monitoring your project files for changes. The command completes after the tests are run once.
--docker-options string Specify the docker run options to use. Value must be in "". The following Docker options are not supported: '--help','-p','--publish-all','-P','-u','-—user','-—name','-—network','-t','-—tty,'—rm','—entrypoint', '--mount'.
-h, --help help for test
-i, --interactive Attach STDIN to the container for interactive TTY mode
--name string Assign a name to your development container. (default "my-project")
--network string Specify the network for docker to use.
--no-watcher Disable file watching, regardless of container environment variable settings.
-p, --publish stringArray Publish the container's ports to the host. The stack's exposed ports will always be published, but you can publish addition ports or override the host ports with this option.
-P, --publish-all Publish all exposed ports to random ports
--stack-registry string Specify the URL of the registry that hosts your stack images. (default "docker.io")
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs
Show the version of the Appsody CLI.
Show the version of the Appsody CLI that is currently in use.
appsody version [flags]
-h, --help help for version
--config string The absolute path to the Appsody config file. Use this option when you want to specify your own, customized config file (default '$HOME/.appsody/.appsody.yaml')
--dryrun Shows the commands that are called by this command, without running them.
-v, --verbose Prints more detailed log output, to the console and to a file in $HOME/.appsody/logs