write-manifest#
Create a manifest.json file for later deployment. This may be used with the git support provided by Posit Connect or by using the "deploy manifest" command in this tool.
Usage:
write-manifest [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
write-manifest api#
Create a manifest.json file for a Python API for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest api [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest bokeh#
Create a manifest.json file for a Bokeh Application for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest bokeh [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest dash#
Create a manifest.json file for a Dash Application for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest dash [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest fastapi#
Create a manifest.json file for a Python FastAPI for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest fastapi [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest flask#
Create a manifest.json file for a Flask API for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest flask [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest gradio#
Create a manifest.json file for a Gradio Application for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest gradio [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest notebook#
Create a manifest.json file for a Jupyter notebook for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the notebook file.
Usage:
write-manifest notebook [OPTIONS] FILE [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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
-v, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest quarto#
Create a manifest.json file for a Quarto document or project for later deployment. Should the content use the Quarto Jupyter engine, an environment file ("requirements.txt") is created if one does not already exist. All files are created in the same directory as the project. 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:
write-manifest quarto [OPTIONS] FILE_OR_DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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.
-v, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest shiny#
Create a manifest.json file for a Python Shiny Application for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest shiny [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest streamlit#
Create a manifest.json file for a Streamlit Application for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the API code.
Usage:
write-manifest streamlit [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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-python 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, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest tensorflow#
Create a manifest.json file for a TensorFlow model for later deployment. All files are created in the same directory as the content. Requires Posit Connect 2024.05.0 or later.
DIRECTORY is the path to a directory containing a TensorFlow model.
Usage:
write-manifest tensorflow [OPTIONS] DIRECTORY [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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.
-v, --verbose Print detailed messages
-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.
--help Show this message and exit.
write-manifest voila#
Create a manifest.json file for a Voila notebook for later deployment. This will create an environment file ("requirements.txt") if one does not exist. All files are created in the same directory as the notebook file.
Usage:
write-manifest voila [OPTIONS] PATH [EXTRA_FILES]...
Options:
-o, --overwrite Overwrite manifest.json, if it exists.
-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, --verbose Print detailed messages
-e, --entrypoint TEXT The module and executable object which
serves as the entry point.
-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.
-m, --multi-notebook Set the manifest for multi-notebook mode.
-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.
--help Show this message and exit.
