deploy#
Deploy content to Posit Connect, Posit Cloud, or shinyapps.io.
Usage:
deploy [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
deploy api#
Deploy a Python API module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy api [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Python API
(defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy bokeh#
Deploy a Bokeh Application module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy bokeh [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Bokeh
Application (defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy dash#
Deploy a Dash Application module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy dash [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Dash
Application (defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy fastapi#
Deploy a Python FastAPI module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy fastapi [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Python
FastAPI (defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy flask#
Deploy a Flask API module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy flask [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Flask API
(defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy gradio#
Deploy a Gradio Application module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy gradio [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Gradio
Application (defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy html#
Deploy an html file, or directory of html files with entrypoint, to Posit Connect or Posit Cloud.
Usage:
deploy html [OPTIONS] PATH [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to deploy
to.
-s, --server TEXT The URL for the Posit Connect server to deploy to.
(Also settable via CONNECT_SERVER environment
variable.)
-k, --api-key TEXT The API key to use to authenticate with Posit
Connect. (Also settable via CONNECT_API_KEY
environment variable.)
-i, --insecure Disable TLS certification/host validation. (Also
settable via CONNECT_INSECURE environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates. (Also
settable via CONNECT_CA_CERTIFICATE environment
variable.)
-v, --verbose Enable verbose output. Use -vv for very verbose
(debug) output.
-N, --new Force a new deployment, even if there is saved
metadata from a previous deployment. Cannot be used
with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot be used
with --new.
-t, --title TEXT Title of the content (default is the same as the
filename).
-E, --environment TEXT Set an environment variable. Specify a value with
NAME=VALUE, or just NAME to use the value from the
local environment. May be specified multiple times.
[v1.8.6+]
--no-verify Don't access the deployed content to verify that it
started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name. (Also
settable via SHINYAPPS_ACCOUNT environment
variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also settable
via SHINYAPPS_TOKEN or RSCLOUD_TOKEN environment
variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret. (Also
settable via SHINYAPPS_SECRET or RSCLOUD_SECRET
environment variables.)
-e, --entrypoint TEXT The name of the html file that is the landing page.
-x, --exclude TEXT Specify a glob pattern for ignoring files when
building the bundle. Note that your shell may try to
expand this which will not do what you expect.
Generally, it's safest to quote the pattern. This
option may be repeated.
--help Show this message and exit.
deploy manifest#
Deploy content to Posit Connect, Posit Cloud, or shinyapps.io using an existing manifest.json file. The specified file must either be named "manifest.json" or refer to a directory that contains a file named "manifest.json".
Usage:
deploy manifest [OPTIONS] FILE
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy notebook#
Deploy a Jupyter notebook to Posit Connect. This may be done by source or as a static HTML page. If the notebook is deployed as a static HTML page (--static), it cannot be scheduled or rerun on the Connect server.
Usage:
deploy notebook [OPTIONS] FILE [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-S, --static Render the notebook locally and deploy the
result as a static document. Will not
include the notebook source. Static
notebooks cannot be re-run on the server.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
--hide-all-input Hide all input cells when rendering output
--hide-tagged-input Hide input code cells with the 'hide_input'
tag
--help Show this message and exit.
deploy other-content#
Show help on how to deploy other content to Posit Connect.
Usage:
deploy other-content [OPTIONS]
Options:
--help Show this message and exit.
deploy quarto#
Deploy a Quarto document or project to Posit Connect or Posit Cloud. Should the content use the Quarto Jupyter engine, an environment file ("requirements.txt") is created and included in the deployment if one does not already exist. Requires Posit Connect 2021.08.0 or later.
FILE_OR_DIRECTORY is the path to a single-file Quarto document or the directory containing a Quarto project.
Usage:
deploy quarto [OPTIONS] FILE_OR_DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-q, --quarto PATH Path to Quarto installation.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
--help Show this message and exit.
deploy shiny#
Deploy a Python Shiny Application module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy shiny [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Python
Shiny Application (defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy streamlit#
Deploy a Streamlit Application module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). The "directory" argument must refer to an existing directory that contains the application code.
Usage:
deploy streamlit [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-A, --account TEXT The shinyapps.io/Posit Cloud account name.
(Also settable via SHINYAPPS_ACCOUNT
environment variable.)
-T, --token TEXT The shinyapps.io/Posit Cloud token. (Also
settable via SHINYAPPS_TOKEN or
RSCLOUD_TOKEN environment variables.)
-S, --secret TEXT The shinyapps.io/Posit Cloud token secret.
(Also settable via SHINYAPPS_SECRET or
RSCLOUD_SECRET environment variables.)
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point for the Streamlit
Application (defaults to app)
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
-V, --visibility [public|private]
The visibility of the resource being
deployed. (shinyapps.io only; must be public
(default) or private)
--help Show this message and exit.
deploy tensorflow#
Deploy a TensorFlow model to Posit Connect. Requires Posit Connect 2024.05.0 or later.
DIRECTORY is the path containing a TensorFlow model.
Usage:
deploy tensorflow [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to deploy
to.
-s, --server TEXT The URL for the Posit Connect server to deploy to.
(Also settable via CONNECT_SERVER environment
variable.)
-k, --api-key TEXT The API key to use to authenticate with Posit
Connect. (Also settable via CONNECT_API_KEY
environment variable.)
-i, --insecure Disable TLS certification/host validation. (Also
settable via CONNECT_INSECURE environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates. (Also
settable via CONNECT_CA_CERTIFICATE environment
variable.)
-v, --verbose Enable verbose output. Use -vv for very verbose
(debug) output.
-N, --new Force a new deployment, even if there is saved
metadata from a previous deployment. Cannot be used
with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot be used
with --new.
-t, --title TEXT Title of the content (default is the same as the
filename).
-E, --environment TEXT Set an environment variable. Specify a value with
NAME=VALUE, or just NAME to use the value from the
local environment. May be specified multiple times.
[v1.8.6+]
--no-verify Don't access the deployed content to verify that it
started correctly.
-I, --image TEXT Target image to be used during content build and
execution. This option is only applicable if the
Connect server is configured to use off-host
execution.
-x, --exclude TEXT Specify a glob pattern for ignoring files when
building the bundle. Note that your shell may try to
expand this which will not do what you expect.
Generally, it's safest to quote the pattern. This
option may be repeated.
--help Show this message and exit.
deploy voila#
Deploy a Jupyter notebook in Voila mode to Posit Connect.
Usage:
deploy voila [OPTIONS] PATH [EXTRA_FILES]...
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
-N, --new Force a new deployment, even if there is
saved metadata from a previous deployment.
Cannot be used with --app-id.
-a, --app-id TEXT Existing app ID or GUID to replace. Cannot
be used with --new.
-t, --title TEXT Title of the content (default is the same as
the filename).
-E, --environment TEXT Set an environment variable. Specify a value
with NAME=VALUE, or just NAME to use the
value from the local environment. May be
specified multiple times. [v1.8.6+]
--no-verify Don't access the deployed content to verify
that it started correctly.
-I, --image TEXT Target image to be used during content build
and execution. This option is only
applicable if the Connect server is
configured to use off-host execution.
--disable-env-management Shorthand to disable environment management
for both Python and R.
--disable-env-management-py Disable Python environment management for
this bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct Python environment
on the Connect server.
--disable-env-management-r Disable R environment management for this
bundle. Connect will not create an
environment or install packages. An
administrator must install the required
packages in the correct R environment on the
Connect server.
-e, --entrypoint TEXT The module and executable object which
serves as the entry point.
-m, --multi-notebook Deploy in multi-notebook mode.
-x, --exclude TEXT Specify a glob pattern for ignoring files
when building the bundle. Note that your
shell may try to expand this which will not
do what you expect. Generally, it's safest
to quote the pattern. This option may be
repeated.
-p, --python PATH Path to Python interpreter whose environment
should be used. The Python environment must
have the rsconnect package installed.
--override-python-version PYTHON-VERSION
An optional python version to use instead of
the version from the detected environment.
-g, --force-generate Force generating "requirements.txt", even if
it already exists.
--help Show this message and exit.
