CLI Docs¶
Installation¶
You can install the pollination-apps cli tool using the following command:
pip install -u pollination-apps
Commands¶
The Pollination Apps CLI
Use this CLI to create a new app and deploy it to Pollination.
Try pollination-apps new and follow the directions for developing the app
and deploying your first app to Pollination.
Commands [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
deploy¶
Deploy a new version of the application.
Commands deploy [OPTIONS] PATH
Options
- -o, --owner <owner>¶
the owner of the app on pollination.
- -n, --name <name>¶
the name of the app.
- -t, --tag <tag>¶
the tag for this version of the app
- --sdk <sdk>¶
- Default:
streamlit- Options:
streamlit | dash
- -m, --message <message>¶
the commit message for this version of the app
- Default:
A new version of the app.
- -e, --environment <environment>¶
the pollination environment
- Default:
production- Options:
staging | production
- --public, --private¶
Indicate if the application should be created as a public or a private resource. This option does not change the visibility of a resource if it already exist.
- Default:
True
- -ep, --entrypoint <entrypoint>¶
Indicate that the entry point module of the application. Default is “app.py”.
- Default:
app.py
- -at, --api-token <api_token>¶
A valid Pollination API token
Arguments
- PATH¶
Required argument
login¶
login to pollination
Commands login [OPTIONS]
Options
- -e, --environment <environment>¶
the pollination environment
- Options:
staging | production
- -t, --token-name <token_name>¶
the name of the api token created for this client
new¶
create a new app
Commands new [OPTIONS]
Options
- -p, --path <path>¶
Path to the app directory. If the directory does not exist, a new directory will be created.
- --sdk <sdk>¶
The SDK to use for the app.
- Default:
streamlit- Options:
streamlit | dash | react
new-from-url¶
Import an app from a git repository.
Commands new-from-url [OPTIONS] URL
Options
- -at, --api-token <api_token>¶
A valid Pollination API token
Arguments
- URL¶
Required argument
run¶
Build and run the application locally.
Commands run [OPTIONS] PATH
Options
- -o, --owner <owner>¶
The owner of the app on pollination. e.g. ladybug-tools
- -n, --name <name>¶
The name of the app.
- -t, --tag <tag>¶
The tag for this version of the app
- -e, --editable¶
An option to set the container to be editable by mounting the app path as a volume to the docker container.
- Default:
False
- --docker, --podman¶
An option to set the preferred container technology. The default is set to docker. You can also use podman as an alternative.
- Default:
True
Arguments
- PATH¶
Required argument