Command: deploy

The deploy command deploys the given runtime environment on the local system and sets it up so you can run it from any shell environment that matches the current shell, overriding any conflicting installations. You can run individual deploy steps by running the sub-commands, which is useful if you’re preparing Docker images or CI/CD environments.


To deploy a project in one step:

state deploy [--path <path>] [--force] <org/project>

You can use the optional --path flag to specify the full path to the deployment directory. Note that projects deployed to a specific directory using the –path flag are not removed when you run state clean uninstall or state clean cache.

You can optionally add the --force flag to overwrite any previous deployment in the default folder or the location specified using the --path flag.

To deploy a project in multiple steps:

  1. Install the language runtime only.

    state deploy install <org/project>
  2. Configure the installed runtime.

    state deploy configure <org/project>
  3. Create a symbolic link to your PATH and to the target directory.

    state deploy symlink <org/project>
  4. Display information about the current configuration

    state deploy report <org/project>