‍

What You Can Do

• Discover - List available products, environments, and local installs
• Install - Install environments to any location on disk
• Update - Update all or specific installed environments
• Launch - Run a launch entry from any installed environment
• Repair - Restore an environment to its expected state
• Uninstall - Remove environments from disk
• Orchestrate - Queue and schedule downloads as part of a shared network

‍

Help Output

Every command supports help as a subcommand. Append --out=json,minify to any session for machine-parsable output.

‍

Discover

‍-List products
-List environments within a named product

‍
‍List local installs ‍

‍Note that Object names are case-sensitive.

‍

Install

The --location argument is required to specify the directory where the environment will be installed.

- Basic Install
- Install a Specific Release Version

Install Using Snapshot

A snapshot consists of previous deployments within the environment.

See Install Environment for more details. You can use a snapshot as a base, plus a specific release version.

Install Optional Repositories

Optional repositories require both the name of the repository and a release version. The release_version arguments supports a "latest" value.

Installation Notes: 

• An environment can be installed to multiple unique locations
• Two distinct environments can be installed to the same location, however, to prevent file collisions and issues during updates, the repositories within those environments:
  
  • Must not manage the same set of files
  • Must not share the same name (e.g. gameclient)
• Windows: elevation is required when installing to protected directories like C:\Program Files\, otherwise the process errors with exit code 3
• Each install session is independent. Optional repositories not named will be excluded. Required repositories not named will update to the latest version.
• Once an optional repository is added to an installation location, updating that location in subsequent sessions results in both required and optional repositories being updated.

‍

Update

Update all environments at once or target by name or location.

-Update All
-Update by Name‍
-Update by Location‍

‍

Launch

Run a launch entry from an installed environment. Use local read to see available launch entry names.

‍

Rollback

local update only goes forward to the latest version.

To roll back, use local install with a --history_id or --release_version.

Note: that any optional repositories not named in the argument string will be uninstalled.

- Roll back using specified versions of multiple repositories
- Roll back using a snapshot

Snapshot history IDs are in the Solsta GUI under the History tab for any environment.

‍

Repair

Verify and restore any environment to its expected state without a full reinstall. As with update, you can repair all, by name or by location.

- Repair All Environments

- Repair by Name

‍

Uninstall

Remove files from disk. As with update, you can uninstall all, by name or by location.

- Uninstall All Environments

- Uninstall by Name

‍