Appearance
start
The start
command restarts a stopped session or starts an application inside an already running session.
Usage: turbo start <options> <session>
<options> available:
-- Parameters after -- are passed directly to the session process
-a, --attach Attach to stdin, stdout, and stderr of the session. This setting is not saved in the session.
--ad-domain-allow=VALUE Allow execution from the Active Directory domain
--ad-domain-deny=VALUE Disallow execution from the Active Directory domain
--ad-group-allow=VALUE Allow execution for members of the Active Directory group
--ad-group-deny=VALUE Disallow execution for members of the Active Directory group
--admin Run the session with administrative permissions
--all-users Applies the configuration settings to All Users
--api-key=VALUE Login with specified API key
--clipboard-mode=VALUE Controls clipboard isolation. Supported values: Bidirectional, InboundOnly, OutboundOnly, Isolated
--clipboard-size=VALUE Maximum clipboard size in bytes. Set to 0 for unlimited.
-d, --detach Run the session in the background
--diagnostic Enable diagnostic logging
--disable=VALUE Disable the specified Turbo VM setting. This setting is not saved in the session. Format: VALUE1[,VALUE2...].
-e, --env=VALUE Set an environment variable inside the session. This setting is not saved in the session.
--enable=VALUE Enable the specified Turbo VM setting. This setting is not saved in the session. Format: VALUE1[,VALUE2...].
--enable-sync Enable session synchronization. This setting is not saved in the session.
--env-file=VALUE Read in a line delimited file of environment variables. This setting is not saved in the session.
--format=VALUE Use the specified format for output. Supported values: json, json-stream
--hide-drive=VALUE Hide specified drives. This setting is not saved in the session. Format: <*|V:|-V:>[,...]
--hosts=VALUE Add an entry to the virtual /etc/hosts file (<redirect>:<name>). This setting is not saved in the session.
-i, --isolate=VALUE Set isolation level: full, write-copy, merge or merge-user.
--link=VALUE Add link to another session (<session>:<alias>). This setting is not saved in the session.
--mirror=VALUE Mirrors a directory path from another session to the current session's corresponding directory path. Format: session:path
--mount=VALUE Mount a host folder into the session. This setting is not saved in the session. Format: [other-session:]SourceFolder[=TargetFolder]
--network=VALUE Run session in specified named network. This setting is not saved in the session.
--no-pull Uses local images to run the session if possible. If not present, will pull from the hub.
--proxy-password=VALUE Password used to connect to the proxy server. It is not required when using Tnlr. This setting is not saved in the session.
--proxy-server=VALUE Proxy or Tnlr server (Tnlr requires TLS). This setting is not saved in the session. Format: [socks5|http|https|tnlr]://proxy-address:port
--proxy-targets=VALUE A list of addresses (separated by semicolons) which will be proxied. If not set, all traffic will go through the proxy. The address could be either a DNS name or an IP address.
--proxy-username=VALUE Username used to connect to the proxy server. It is not required when using Tnlr. This setting is not saved in the session.
--pull Pulls base images from hub before running, if they exist
--route-add=VALUE Add route mapping. Supported protocols: ip, pipe, tcp, and udp. This setting is not saved in the session.
--route-block=VALUE Block specified route or protocol. Supported protocols: ip, tcp, and udp. This setting is not saved in the session.
--route-file=VALUE Read in a INI file of routing configuration. This setting is not saved in the session.
--set-startup-file=VALUE Override the default startup file permanantly
--set-startup-verb=VALUE Override the default startup verb permanantly
--show-window=VALUE Controls how window is shown. Supported values: max, default
--skin-border-color=VALUE Sets the UI skin color. Accepts color names (e.g., 'red') or hex values (e.g., '#FF0000').
--startup-file=VALUE Override the default startup file. This setting is not saved in the session.
--startup-verb=VALUE Override the default startup verb. This setting is not saved in the session.
--stream Enable streaming of the image if available
--temp Remove session when it exits
--trigger=VALUE Execute named group of startup files. This setting is not saved in the session.
--using=VALUE Use specified images as a temporary dependency
--vm=VALUE Use the specified Turbo VM version for execution
-w, --working-dir=VALUE Set the initial working directory inside the session. This setting is not saved in the session.
--wait-after-error Leave session open after error
--wait-after-exit Leave session open after it exits
If the start
command is run against an already-running session then no action will be taken.
To enable diagnostic logging for the session, specify the --diagnostic
flag.
To run the session in the background then specify the -d
or --detach
flag.
To temporarily alter the startup file, specify it with --startup-file
parameter. The change overrides the original startup files and does not apply to a subsequent session starts or commits.
When the session stops, the exit code of startup file is displayed in decimal form.
JSON output
When --format=json
option was passed this command will provide output in JSON format. It will contain session
object with information about started session or an error
object if command failed.