Tethys Platform
Table Of Contents
Table Of Contents

install command

This command is used to trigger an automatic install for an application on a portal. We recommend using an install.yml file in the app directory to customize the installation process. If the install file doesn't exist the command will offer to create a blank template install.yml file for you. If you require services to be setup automatically, place a services.yml file in the root of your application. If there are any services that are needed by settings in your app that haven't been setup yet, you will be prompted to configure them interactively during the installation process. If there are any linked persistent stores upon completing the installation process, the install command will automatically run tethys syncstores {app_name}. Finally, any scripts listed in the install.yml will be run to finish the installation.

usage: tethys install [-h] [-d] [-f FILE] [-s SERVICES_FILE]
                      [--force-services] [-q] [-n] [-N] [-v] [-u] [-o] [-w]

Named Arguments

-d, --develop

Will run setup.py develop instead of setup.py install

Default: False

-f, --file

The path to the Install file.

-s, --services-file

The path to the Services.yml config file


Force Services.yml file over portal_config.yml file

Default: False

-q, --quiet

Skips interactive mode.

Default: False

-n, --no-sync-stores

Skips syncstores when linked persistent stores are found.

Default: False

-N, --no-db-sync

Skips any database related commands.

Default: False

-v, --verbose

Will show all pip install output when enabled.

Default: False

-u, --update-installed

Will attempt to update already installed dependencies to versions listed in the install.yml. WARNING: This may break your Tethys installation and is not recommended.

Default: False

-o, --only-dependencies

Install only the dependencies of an app or extension.

Default: False

-w, --without-dependencies

Install the app or extension without installing its dependencies.

Default: False

Table Of Contents