Appsody CLI

appsody

Appsody CLI

Synopsis

The Appsody command-line tool (CLI) enables the rapid development of cloud native applications.

Complete documentation is available at https://appsody.dev

Options

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -h, --help            help for appsody
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody build

Locally build a docker image of your appsody project

Synopsis

This allows you to build a local Docker image from your Appsody project. Extract is run before the docker build.

appsody build [flags]

Options

  -h, --help         help for build
  -t, --tag string   Docker image name and optionally a tag in the 'name:tag' format

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody completion

Generates bash tab completions

Synopsis

Outputs a bash completion script for appsody to stdout. Bash completion is optionally available for your convenience. It helps you fill out appsody commands when you type the [TAB] key.

To install on macOS
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
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
appsody completion [flags]

Options

  -h, --help   help for completion

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody debug

Run the local Appsody environment in debug mode

Synopsis

This starts a docker based continuous build environment for your project with debugging enabled.

appsody debug [flags]

Options

      --deps-volume string    Docker volume to use for dependencies. Mounts to APPSODY_DEPS dir. (default "my-project-deps")
  -h, --help                  help for debug
      --name string           Assign a name to your development container. (default "my-project-dev")
      --network string        Specify the network for docker to use.
  -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

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody deploy

Build and deploy your Appsody project on a local Kubernetes cluster

Synopsis

This command extracts the code from your project, builds a local Docker image for deployment, generates a KNative serving deployment manifest (yaml) file, and deploys your image as a KNative service in your local cluster.

appsody deploy [flags]

Options

  -h, --help               help for deploy
  -n, --namespace string   Target namespace in your Kubernetes cluster
      --push               Push this image to an external Docker registry. Assumes that you have previously successfully done docker login
  -t, --tag string         Docker image name and optionally a tag in the 'name:tag' format

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody extract

Extract the stack and your Appsody project to a local directory

Synopsis

This copies the full project, stack plus app, into a local directory in preparation to build the final docker image.

appsody extract [flags]

Options

  -h, --help                help for extract
      --name string         Assign a name to your development container. (default "my-project-extract")
      --target-dir string   Directory path to place the extracted files. This dir must not exist, it will be created.

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody init

Initialize an Appsody project with a stack and template app

Synopsis

This creates a new Appsody project in a local directory or sets up the local dev environment of an existing Appsody project.

If the [repository] is not specified the default repository will be used. With the [stack] or [repository]/[stack] argument, this command will setup a new Appsody project. It will create an Appsody stack config file, unzip a template app, and run the stack init script to setup the local dev environment. It is typically run on an empty directory and may fail if files already exist. See the --overwrite and --no-template options for more details. Use 'appsody list' to see the available stack options.

Without the [stack] argument, this command must be run on an existing Appsody project and will only run the stack init script to setup the local dev environment.

appsody init [stack] or [repository]/[stack] [flags]

Options

  -h, --help          help for init
      --no-template   Only create the .appsody-config.yaml file. Do not unzip the template project.
      --overwrite     Download and extract the template project, overwriting existing files.

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody list

List the Appsody stacks available to init

Synopsis

This command lists all the stacks available in your repositories. If you omit the optional [repository] parameter, the stacks for all the repositories are listed. If you specify the repository name [repository], only the stacks in that repository will be listed.

appsody list [repository] [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody repo

Manage your Appsody repositories

Synopsis

Manage your Appsody repositories

Options

  -h, --help   help for repo

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody repo add

Add an Appsody repository

Synopsis

Add an Appsody repository

appsody repo add <name> <url> [flags]

Options

  -h, --help   help for add

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody repo list

List configured Appsody repositories

Synopsis

List configured Appsody repositories. An asterisk denotes the default repository.

appsody repo list [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody repo remove

Remove a configured Appsody repository

Synopsis

Remove a configured Appsody repository

appsody repo remove <name> [flags]

Options

  -h, --help   help for remove

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody repo set-default

Set desired default repository

Synopsis

Set desired default repository

appsody repo set-default <name> [flags]

Options

  -h, --help   help for set-default

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody run

Run the local Appsody environment for your project

Synopsis

This starts a docker based continuous build environment for your project.

appsody run [flags]

Options

      --deps-volume string    Docker volume to use for dependencies. Mounts to APPSODY_DEPS dir. (default "my-project-deps")
  -h, --help                  help for run
      --name string           Assign a name to your development container. (default "my-project-dev")
      --network string        Specify the network for docker to use.
  -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

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody stop

Stops the local Appsody docker container for your project

Synopsis

Stop the local Appsody docker container for your project.

Stops the docker container specified by the --name flag. If --name is not specified, the container name is determined from the current working directory (see default below). To see a list of all your running docker containers, run the command "docker ps". The name is in the last column.

appsody stop [flags]

Options

  -h, --help          help for stop
      --name string   Assign a name to your development container. (default "my-project-dev")

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody test

Test your project in the local Appsody environment

Synopsis

This starts a docker container for your project and runs your test in it.

appsody test [flags]

Options

      --deps-volume string    Docker volume to use for dependencies. Mounts to APPSODY_DEPS dir. (default "my-project-deps")
  -h, --help                  help for test
      --name string           Assign a name to your development container. (default "my-project-dev")
      --network string        Specify the network for docker to use.
  -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

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO

appsody version

Show Appsody CLI version

Synopsis

Show Appsody CLI version

appsody version [flags]

Options

  -h, --help   help for version

Options inherited from parent commands

      --config string   config file (default is $HOME/.appsody/.appsody.yaml)
      --dryrun          Turns on dry run mode
  -v, --verbose         Turns on debug output and logging to a file in $HOME/.appsody/logs

SEE ALSO