command-line options:
verify:
--verify-installation arg (=0) Verifies that the session installation
is working correctly and exits.
version:
--version [=arg(=1)] (=0) Prints the version number and exits.
automation:
--run-automation [=arg(=1)] (=0) Run automation tests and exit.
--automation-agent [=arg(=1)] (=0) Run RStudio as an automation agent.
--automation-report-file arg The file where automation test results
should be written.
tests:
--run-tests [=arg(=1)] (=0) Runs unit tests and exits.
script:
--run-script arg Runs an R script and exits.
program:
--program-mode arg (=server) The program mode the session is running
in (desktop or server).
log:
--log-stderr arg (=0) Writes log entries to stderr in
addition to any other configured log
destinations.
docs:
--docs-url arg If specified, overrides the URL to
navigate to when a user clicks on the
RStudio help link.
www:
--www-local-path arg (=www) The relative path from the RStudio
installation directory, or absolute
path where web assets are stored.
--www-symbol-maps-path arg (=www-symbolmaps)
The relative path from the RStudio
installation directory, or absolute
path, where symbol maps are stored.
--www-port arg (=8787) The HTTP port to listen on for incoming
connections. This is generally only
used with Launcher sessions.
--www-address arg (=127.0.0.1) The address to listen on for incoming
connections. This is generally only
used with Launcher sessions.
--standalone arg (=0) Runs the session in standalone mode,
indicating we should use HTTP
communication. This is generally only
used with Launcher sessions.
--verify-signatures arg (=0) Indicates whether or not to verify
signatures on incoming requests. This
is generally only used with Launcher
sessions.
--www-reuse-ports arg (=0) Whether or not to reuse last used bound
ports when restarting a Launcher
session.
--disable-new-csrf-checks arg (=0) Certain rpc calls were missing checks
for the CSRF token to prevent misuse of
these api in a context with lax
SameSite cookie policies. Use this
option temporarily to override these
new checks if you have integrations
that rely on the old behavior.
session:
--session-connections-block-suspend arg (=1)
Whether or not an active database
connection should block attempts to
suspend the session after timeout.
--session-external-pointers-block-suspend arg (=1)
Whether or not R objects containing
external pointers should block attempts
to suspend the session after timeout.
--session-timeout-minutes arg (=120) The amount of minutes before a session
times out, at which point the session
will either suspend or exit.
--session-timeout-suspend arg (=1) Indicates whether or not to suspend the
session after the timeout has elapsed.
Setting this to `false` will cause the
session to quit instead of suspending
to disk when the session times out.
--session-disconnected-timeout-minutes arg (=0)
If set, causes the session to time out
after not receiving any new connections
within the specified minutes. This
behavior is generally not needed, and
you should instead use
session-timeout-minutes
--session-preflight-script arg Sets a script to be run on startup
before any R initialization has
occurred.
--session-create-public-folder arg (=0)
Indicates whether or not to create a
`Public` folder for the user whenever
the session starts. This folder will
have global read permissions, and can
be used as a simple means for users to
share files. It is recommended you do
not use this feature, and instead use
the more advanced Project Sharing
features.
--session-create-profile arg (=0) Indicates whether or not to create a
default empty .Rprofile script within
the user's home directory, which can be
altered to perform any desired common
startup tasks.
--session-rprofile-on-resume-default arg (=0)
Specifies the default user setting for
running the Rprofile when sessions are
resumed.
--session-save-action-default arg Specifies the default save action (yes,
no, or ask).
--session-default-working-dir arg Specifies the default working directory
to use for new sessions.
--session-default-new-project-dir arg (=~)
Specifies the default directory to use
for new projects.
--show-help-home arg (=0) Indicates whether or not to show the
help home page on startup.
--session-default-console-term arg (=xterm-256color)
Specifies the default TERM setting for
the R console.
--session-default-clicolor-force arg (=1)
Specifies the default CLICOLOR_FORCE
setting for the R console.
--session-quit-child-processes-on-exit arg (=0)
Indicates whether or not to quit child
processes of the session on exit. If
unset, child processes created by
forking or parallel processing may
continue to run in the background after
the session is terminated.
--session-first-project-template-path arg
Specifies the path to a first project
template which will be copied into new
users' home directories and opened the
first time they run a session. The
template can optionally be configured
with `DefaultOpenDocs` to cause
documents to automatically be opened
for the first project.
--default-rsconnect-server arg Specifies the default Posit Connect
server URL.
--terminal-port arg If specified, sets the port to bind the
terminal server to. This should
generally only be set for containerized
Launcher sessions, where the port must
be known.
--websocket-ping-seconds arg (=10) Specifies the WebSocket keep-alive ping
interval for session terminals.
--websocket-connect-timeout arg (=5) Specifies the WebSocket initial
connection timeout in seconds for
session terminals.
--websocket-log-level arg (=0) Specifies the WebSocket log level for
session terminals ((0=none, 1=errors,
2=activity, 3=all).
--websocket-handshake-timeout arg (=5000)
Specifies the WebSocket protocol
handshake timeout for session terminals
in milliseconds.
--package-output-to-package-folder arg (=0)
Specifies whether or not package builds
output to the package project folder.
--session-root-path arg (=/) The path prefix added by a proxy to the
incoming RStudio URL. This setting is
used so RStudio Server knows what path
it is being served from. If running
RStudio Server behind a path-modifying
proxy, this should be changed to match
the base RStudio Server URL.
--session-use-secure-cookies arg (=0) Indicates whether or not to mark
cookies as secure.
--session-same-site arg (=0) The value of the SameSite attribute
used in cookie issued by the session.
--session-www-frame-origin arg The www-frame-origin value forwarded
from rserver, used for CSP
frame-ancestors directives.
--restrict-directory-view arg (=0) Indicates whether or not to restrict
the directories that can be viewed
within the IDE.
--directory-view-allow-list arg Specifies a list of directories exempt
from directory view restrictions,
separated by a colon character (:).
--session-port-range arg Constrain the range of TCP ports
available to the session. Accepts a
range in the form '<lower>-<upper>',
e.g. 59000-59999.
--session-ephemeral-env-vars arg Specifies a list of environment
variables that will not be saved when
sessions suspend, separated by a colon
character (:).
--session-suspend-on-incomplete-statement arg (=0)
Specifies whether the session should be
allowed to suspend when a user has
entered a partial R statement.
--session-async-rpc-enabled arg (=1) Enables async responses to rpc requests
to prevent connection logjams in the
browser, allowing interrupt of busy
sessions
--session-async-rpc-timeout-ms arg (=200)
Duration in millis before requests are
converted to async - i.e. how fast will
the server free up connections when
it's busy
--session-handle-offline-enabled arg (=1)
Enables offline request handling. When
the R process is busy, some requests
are allowed to run
--session-handle-offline-timeout-ms arg (=200)
Duration in millis before requests that
can be handled offline are processed by
the offline handler thread.
--session-use-file-storage arg (=1) Controls whether the session should
store its metadata on the file system
or send it to the server to be stored
in the internal database.
--session-project-user-data-dir arg The folder in which RStudio should
store user-specific project
(.Rproj.user) data.
--session-allow-project-user-data-dir-override arg (=1)
Whether or not users can override the
default project (.Rproj.user) data
directory via their own user
preferences.
--open-files arg Files to open on session load.
allow:
--allow-vcs-executable-edit arg (=1) Indicates whether or not to allow
editing of VCS (Version Control
Systems) executables.
--allow-r-cran-repos-edit arg (=1) Indicates whether or not to allow
editing of CRAN repositories.
--allow-vcs arg (=1) Indicates whether or not to allow the
use of version control features.
--allow-package-installation arg (=1) Indicates whether or not to allow
installation of packages from the
packages pane.
--allow-package-source-recording arg (=1)
Indicates whether or not to annotate
the DESCRIPTION file of packages
installed via install.packages() with
their repository source (RemoteType,
RemoteRepos, etc).
--allow-shell arg (=1) Indicates whether or not to allow
access to the shell dialog.
--allow-terminal-websockets arg (=1) Indicates whether or not to allow
connections to terminal sessions with
websockets.
--allow-file-downloads arg (=1) Indicates whether or not to allow file
downloads from the files pane.
--allow-file-uploads arg (=1) Indicates whether or not to allow file
uploads from the files pane.
--allow-remove-public-folder arg (=1) Indicates whether or not to allow
removal of the user public folder.
--allow-rpubs-publish arg (=1) Indicates whether or not to allow
publishing of content to external
services.
--allow-external-publish arg (=1) Indicates whether or not to allow
publishing of content to external
services.
--allow-publish arg (=1) Indicates whether or not to allow
publishing of content.
--allow-presentation-commands arg (=0)
Indicates whether or not to allow
presentation commands.
--allow-full-ui arg (=1) Indicates whether or not to allow full
standalone UI mode.
--allow-launcher-jobs arg (=1) Indicates whether or not to allow
running jobs via the Launcher.
--allow-over-limit-sessions arg (=0) Indicates whether or not to abort
sessions that exceed their specified
memory limit. Users will still see
warnings and an error.
--abort-free-mem-percent arg (=5) Sessions will be aborted if there is
less than 100 MiB of free RAM or this
configured percentage. Disable abort
entirely by enabling
allow-over-limit-sessions. Increase
this value for easily reproducing this
scenario in a test environment or to
more strictly enforce memory limits on
the system.
--allow-copilot arg (=1) Indicates whether or not to allow use
of Copilot-related features.
--allow-posit-assistant arg (=0) Indicates whether or not to allow use
of Posit Assistant features.
r:
--r-core-source arg (=R) Specifies the Core R source path.
--r-modules-source arg (=R/modules) Specifies the Modules R source path.
--r-session-library arg (=R/library) Specifies the R library path.
--r-session-package-archives arg (=R/packages)
Specifies the R package archives path.
--r-libs-user arg Specifies the R user library path.
--r-cran-repos arg Specifies the default CRAN repository.
--r-cran-repos-file arg (=/etc/rstudio/repos.conf)
Specifies the path to a configuration
file which contains default CRAN
repositories.
--r-cran-repos-url arg Specifies the URL to a configuration
file which contains optional CRAN
repositories.
--r-auto-reload-source arg (=0) Indicates whether or not to
automatically reload R source if it
changes during the session.
--r-compatible-graphics-engine-version arg (=17)
Specifies the maximum graphics engine
version that this version of RStudio is
compatible with.
--r-resources-path arg (=resources) Specifies the directory containing
external resources.
--r-shell-escape arg (=0) Indicates whether or not to support
shell escape.
--r-home-dir-override arg Specifies the override for R_HOME (used
for debug configurations).
--r-doc-dir-override arg Specifies the override for R_DOC_DIR
(used for debug configurations).
--r-restore-workspace arg (=2) If set, overrides the user/project
restore workspace setting. Can be 0
(No), 1 (Yes), or 2 (Default).
--r-run-rprofile arg (=2) If set, overrides the user/project
.Rprofile run setting. Can be 0 (No), 1
(Yes), or 2 (Default).
--r-max-connections arg (=0) Sets the maximum number of connections
that R will support. Valid values are
128 to 4096. When set, the value is
applied to the R startup parameters. If
set to 0 (the default), the R default
(128) will be used. Requires R >=
4.4.0.
limits:
--limit-file-upload-size-mb arg (=0) Sets a size limit in megabytes on files
that are uploaded via the files pane.
--limit-cpu-time-minutes arg (=0) Sets a limit in minutes for the amount
of time top level R computations may
run before being interrupted.
--limit-xfs-disk-quota arg (=0) Indicates whether or not XFS quotas
should be enforced when performing file
operations via the files pane.
external:
--external-rpostback-path arg (=bin/rpostback)
Specifies the path to the rpostback
executable.
--external-consoleio-path arg (=bin/consoleio.exe)
Specifies the path to the consoleio
executable (Windows-only).
--external-gnudiff-path arg (=bin/gnudiff)
Specifies the path to gnudiff utilities
(Windows-only).
--external-gnugrep-path arg (=bin/gnugrep/3.0)
Specifies the path to gnugrep utilities
(Windows-only).
--external-msysssh-path arg (=bin/msys-ssh-1000-18)
Specifies the path to msys_ssh
utilities (Windows-only).
--external-sumatra-path arg (=bin/sumatra)
Specifies the path to SumatraPDF
(Windows-only).
--external-winutils-path arg (=bin/winutils)
Specifies the path to Hadoop Winutils
(Windows-only).
--external-hunspell-dictionaries-path arg (=resources/dictionaries)
Specifies the path to hunspell
dictionaries.
--external-mathjax-path arg (=resources/mathjax-27)
Specifies the path to the mathjax
library.
--external-pandoc-path arg (=bin/quarto/bin/tools)
Specifies the path to pandoc binaries.
--external-quarto-path arg (=bin/quarto)
Specifies the path to quarto binaries.
--external-copilot-path arg (=bin/copilot-language-server-js)
Specifies the path to Copilot Language
Server JavaScript distribution.
--external-node-path arg (=bin/node) Specifies the path to node binaries.
--external-copilot-agent-path arg Specifies the path to the GitHub
Copilot agent.
--external-libclang-path arg (=bin/rsclang)
Specifies the path to the libclang
shared library
--external-libclang-headers-path arg (=resources/libclang/builtin-headers)
Specifies the path to the libclang
builtin headers.
--external-winpty-path arg (=bin) Specifies the path to winpty binaries.
git:
--git-commit-large-file-size arg (=5242880)
Warns when attempting to commit files
larger than this size (in bytes; set 0
to disable).
user:
-u [ --user-identity ] arg (=nobody) The user identity for the session.
--show-user-identity arg (=1) Indicates whether or not to show the
user identity in the session UI.
-p [ --project ] arg Specifies the active project.
-s [ --scope ] arg Specifies the session identifier.
--launcher-token arg Specifies the token identifying the
session launcher.
pai:
--posit-assistant-enabled arg (=1) Indicates whether or not Posit
Assistant integration can be enabled.
--posit-assistant-ssl-certificates-file arg
The path to a file containing one or
more trusted certificates in PEM
format.
--posit-assistant-helper arg The path to an optional shell script,
which when invoked, should start the
Posit Next Edit Suggestions Language
Server.
--posit-assistant-test-manifest [=arg(=1)] (=0)
Use the test manifest URL for Posit
Assistant package updates.
copilot:
--copilot-enabled arg (=0) Indicates whether or not GitHub Copilot
integration can be enabled.
--copilot-proxy-url arg The proxy URL that the Copilot agent
should use for outgoing network
requests. Only plain HTTP proxy URLs
are supported.
--copilot-auth-provider arg The URL to the authentication provider
to be used by GitHub Copilot.
--copilot-proxy-kerberos-service-principal arg
The Kerberos service principal to use
for authenticating GitHub Copilot with
the proxy.
--copilot-ssl-certificates-file arg The path to a file containing one or
more trusted certificates in PEM
format.
--copilot-proxy-strict-ssl arg (=1) Should the GitHub Copilot agent perform
SSL certificate validation when forming
web requests?
--copilot-agent-helper arg The path to an optional shell script,
which when invoked, should start the
GitHub Copilot agent.
--copilot-helper arg The path to an optional shell script,
which when invoked, should start the
GitHub Copilot Language Server.
trust:
--project-trust-dialogs arg (=-1) When enabled (1), RStudio will prompt
users to trust project directories that
contain auto-executing files
(.Rprofile, .RData, .Renviron). When
disabled (0), all directories are
implicitly trusted. When unset (-1),
the default depends on the edition of
RStudio.
misc:
general:
--help print help message
--test-config test to ensure the config file is valid
--config-file arg configuration file
Options (97)
| Option | Description | Source |
|---|---|---|
--verify-installation arg | Verifies that the session installation is working correctly and exits. | help |
--version arg(=1) | Prints the version number and exits. | help |
--run-automation arg(=1) | Run automation tests and exit. | help |
--automation-agent arg(=1) | Run RStudio as an automation agent. | help |
--automation-report-file arg | The file where automation test results should be written. | help |
--run-tests arg(=1) | Runs unit tests and exits. | help |
--run-script arg | Runs an R script and exits. | help |
--program-mode arg | The program mode the session is running in (desktop or server). | help |
--log-stderr arg | Writes log entries to stderr in addition to any other configured log destinations. | help |
--docs-url arg | If specified, overrides the URL to navigate to when a user clicks on the RStudio help link. | help |
--www-local-path arg | The relative path from the RStudio installation directory, or absolute path where web assets are stored. | help |
--www-port arg | The HTTP port to listen on for incoming connections. | help |
--www-address arg | The address to listen on for incoming connections. | help |
--standalone arg | Runs the session in standalone mode, indicating we should use HTTP communication. | help |
--verify-signatures arg | Indicates whether or not to verify signatures on incoming requests. | help |
--www-reuse-ports arg | Whether or not to reuse last used bound ports when restarting a Launcher session. | help |
--disable-new-csrf-checks arg | Certain rpc calls were missing checks for the CSRF token to prevent misuse of these api in a context with lax SameSite cookie policies. | help |
--session-timeout-minutes arg | The amount of minutes before a session times out, at which point the session will either suspend or exit. | help |
--session-timeout-suspend arg | Indicates whether or not to suspend the session after the timeout has elapsed. | help |
--session-preflight-script arg | Sets a script to be run on startup before any R initialization has occurred. | help |
--session-create-profile arg | Indicates whether or not to create a default empty .Rprofile script within the user's home directory, which can be altered to perform any desired common startup tasks. | help |
--session-save-action-default arg | Specifies the default save action (yes, no, or ask). | help |
--session-default-working-dir arg | Specifies the default working directory to use for new sessions. | help |
--show-help-home arg | Indicates whether or not to show the help home page on startup. | help |
--session-first-project-template-path arg | Specifies the path to a first project template which will be copied into new users' home directories and opened the first time they run a session. | help |
--default-rsconnect-server arg | Specifies the default Posit Connect server URL. | help |
--terminal-port arg | If specified, sets the port to bind the terminal server to. | help |
--websocket-ping-seconds arg | Specifies the WebSocket keep-alive ping interval for session terminals. | help |
--websocket-connect-timeout arg | Specifies the WebSocket initial connection timeout in seconds for session terminals. | help |
--websocket-log-level arg | Specifies the WebSocket log level for session terminals ((0=none, 1=errors, 2=activity, 3=all). | help |
--session-root-path arg | The path prefix added by a proxy to the incoming RStudio URL. | help |
--session-same-site arg | The value of the SameSite attribute used in cookie issued by the session. | help |
--session-www-frame-origin arg | The www-frame-origin value forwarded from rserver, used for CSP frame-ancestors directives. | help |
--restrict-directory-view arg | Indicates whether or not to restrict the directories that can be viewed within the IDE. | help |
--directory-view-allow-list arg | Specifies a list of directories exempt from directory view restrictions, separated by a colon character (:). | help |
--session-port-range arg | Constrain the range of TCP ports available to the session. | help |
--session-ephemeral-env-vars arg | Specifies a list of environment variables that will not be saved when sessions suspend, separated by a colon character (:). | help |
--session-async-rpc-enabled arg | Enables async responses to rpc requests to prevent connection logjams in the browser, allowing interrupt of busy sessions | help |
--session-use-file-storage arg | Controls whether the session should store its metadata on the file system or send it to the server to be stored in the internal database. | help |
--session-project-user-data-dir arg | The folder in which RStudio should store user-specific project (.Rproj.user) data. | help |
--open-files arg | Files to open on session load. | help |
--allow-vcs-executable-edit arg | Indicates whether or not to allow editing of VCS (Version Control Systems) executables. | help |
--allow-r-cran-repos-edit arg | Indicates whether or not to allow editing of CRAN repositories. | help |
--allow-vcs arg | Indicates whether or not to allow the use of version control features. | help |
--allow-shell arg | Indicates whether or not to allow access to the shell dialog. | help |
--allow-terminal-websockets arg | Indicates whether or not to allow connections to terminal sessions with websockets. | help |
--allow-file-downloads arg | Indicates whether or not to allow file downloads from the files pane. | help |
--allow-file-uploads arg | Indicates whether or not to allow file uploads from the files pane. | help |
--allow-rpubs-publish arg | Indicates whether or not to allow publishing of content to external services. | help |
--allow-external-publish arg | Indicates whether or not to allow publishing of content to external services. | help |
--allow-publish arg | Indicates whether or not to allow publishing of content. | help |
--allow-full-ui arg | Indicates whether or not to allow full standalone UI mode. | help |
--allow-launcher-jobs arg | Indicates whether or not to allow running jobs via the Launcher. | help |
--allow-over-limit-sessions arg | Indicates whether or not to abort sessions that exceed their specified memory limit. | help |
--abort-free-mem-percent arg | Sessions will be aborted if there is less than 100 MiB of free RAM or this configured percentage. | help |
--allow-copilot arg | Indicates whether or not to allow use of Copilot-related features. | help |
--allow-posit-assistant arg | Indicates whether or not to allow use of Posit Assistant features. | help |
--r-core-source arg | Specifies the Core R source path. | help |
--r-modules-source arg | Specifies the Modules R source path. | help |
--r-session-library arg | Specifies the R library path. | help |
--r-libs-user arg | Specifies the R user library path. | help |
--r-cran-repos arg | Specifies the default CRAN repository. | help |
--r-cran-repos-url arg | Specifies the URL to a configuration file which contains optional CRAN repositories. | help |
--r-auto-reload-source arg | Indicates whether or not to automatically reload R source if it changes during the session. | help |
--r-resources-path arg | Specifies the directory containing external resources. | help |
--r-shell-escape arg | Indicates whether or not to support shell escape. | help |
--r-home-dir-override arg | Specifies the override for R_HOME (used for debug configurations). | help |
--r-doc-dir-override arg | Specifies the override for R_DOC_DIR (used for debug configurations). | help |
--r-restore-workspace arg | If set, overrides the user/project restore workspace setting. | help |
--r-run-rprofile arg | If set, overrides the user/project .Rprofile run setting. | help |
--r-max-connections arg | Sets the maximum number of connections that R will support. | help |
--limit-file-upload-size-mb arg | Sets a size limit in megabytes on files that are uploaded via the files pane. | help |
--limit-cpu-time-minutes arg | Sets a limit in minutes for the amount of time top level R computations may run before being interrupted. | help |
--limit-xfs-disk-quota arg | Indicates whether or not XFS quotas should be enforced when performing file operations via the files pane. | help |
--external-node-path arg | Specifies the path to node binaries. | help |
--external-copilot-agent-path arg | Specifies the path to the GitHub Copilot agent. | help |
--external-winpty-path arg | Specifies the path to winpty binaries. | help |
-u | The user identity for the session. | help |
--show-user-identity arg | Indicates whether or not to show the user identity in the session UI. | help |
-p | Specifies the active project. | help |
-s | Specifies the session identifier. | help |
--launcher-token arg | Specifies the token identifying the session launcher. | help |
--posit-assistant-enabled arg | Indicates whether or not Posit Assistant integration can be enabled. | help |
--posit-assistant-ssl-certificates-file arg | The path to a file containing one or more trusted certificates in PEM format. | help |
--posit-assistant-helper arg | The path to an optional shell script, which when invoked, should start the Posit Next Edit Suggestions Language Server. | help |
--copilot-enabled arg | Indicates whether or not GitHub Copilot integration can be enabled. | help |
--copilot-proxy-url arg | The proxy URL that the Copilot agent should use for outgoing network requests. | help |
--copilot-auth-provider arg | The URL to the authentication provider to be used by GitHub Copilot. | help |
--copilot-proxy-kerberos-service-principal arg | The Kerberos service principal to use for authenticating GitHub Copilot with the proxy. | help |
--copilot-ssl-certificates-file arg | The path to a file containing one or more trusted certificates in PEM format. | help |
--copilot-proxy-strict-ssl arg | Should the GitHub Copilot agent perform SSL certificate validation when forming web requests? | help |
--copilot-agent-helper arg | The path to an optional shell script, which when invoked, should start the GitHub Copilot agent. | help |
--copilot-helper arg | The path to an optional shell script, which when invoked, should start the GitHub Copilot Language Server. | help |
--project-trust-dialogs arg | When enabled (1), RStudio will prompt users to trust project directories that contain auto-executing files (.Rprofile, .RData, .Renviron). | help |
--help | print help message | help |
--test-config | test to ensure the config file is valid | help |
--config-file arg | configuration file | help |