Command Reference
Accessing the help
To see the integrated help, use one of the following:
runway
runway -?
runway --helpHere is the usage:
Usage: runway [-?qviupSl] [COMMAND] [COMMAND OPTIONS] Flags and Parameters
The following is a list of the flags and parameters available on the BrazenCloud utility.
-?, --help Display help
-q, --quiet Quiet mode
-v, --version Display version info and exit
-i, --interactive Run utility in interactive mode, where it will prompt you for missing inputs
-u, --username Supply a valid email address for authentication to an associated runway cloud
-p, --password Supply passphrase for authentication to an associate runway cloud
-S, --SERVER Supply address of runway server ('localhost', 'http://localhost:5000')
-N, --NOUPDATE Don't update the runner with latest versions
-l, --loglevel Sets the log level of this console
-l, --log-no-console Disables console logging
("error"|"warn"|"info"|"verbose"|"trace"|"debug")
(optional)(default: "info")All of these except for -?, --help, -q, --quiet, and -v, --version can be used to qualify most commands.
Commands
login Login to runway cloud with credentials
logout Logout
who Check who you are logged in as
build Builds a runway action that can be deployed and executed on a named group
push Publish a previously built Runway action to the Runway action store
pull Downloads a previously published runway action from the cloud repo
create Create a named group of endpoints upon which you can run actions
connect Instance a named data-connection to a local datastore or service
dissolve Dissolve a named group of endpoints
run Run an action over a named group of endpoints
token Generate an enrollment token for endpoints
node Start a runway node relative to the current directory
discover Discovers the network
download Downloads the job results
download_logs Downloads the runner logs
shell Connects a shell console to the specified remote runner
stream Connect or listen the runway stream
datahub Connect to the datahub
copy Copies files to and from remote runners
install Install the runner as a service
uninstall Uninstall the runner service
deploy Installs a deployed runner
upload Uploads asset map data
job Assigns the job to a runnerlogin
Login to runway cloud with credentials
Usage: runway login [OPTIONS]
Options:
-u, --username Username
(optional - queried if not supplied)
-p, --password Password
(optional - queried if not supplied)logout
Logout
Usage: runway logoutwho
Check who you are logged in as
Usage: runway whobuild
Builds a runway action that can be deployed and executed on a named group
Usage: runway build [OPTIONS]
Options:
-i, --input Path to the Runway application manifest that should be built
(optional)(default: ".\runway.app")
* -o, --output [string] The name of the new action that should be built
* -g, --group [guid] Additional group in which to place this action
(optional)(the action is always placed into your home folder)
* -p, --publish [string] The fully qualified namespace to publish the app package under
(optional)(default: package is built locally and not published)
* -P, --PUBLIC Make the action publically available in Runwaypush
Publish a previously built Runway action to the Runway action store
Usage: runway push [OPTIONS]
Options:
-i, --input Path to the previously built Runway application package
(optional)(default: ".\runway.pkg")
* -n, --name [string] The fully qualified namespace to publish the action package under
* -P, --PUBLIC Make the action publically available in Runwaypull
Downloads a previously published runway action from the cloud repo
Usage: runway pull [OPTIONS]
Options:
* -n, --name [string] The qualified namespace of the target action to download
--extract Extract the downloaded action
--extract [string] (optional arg) The directory in which the action should be extractedcreate
Create a named group of endpoints upon which you can run actions
Usage: runway create [OPTIONS]
Options:
'*' indicates an option field is required
* -n, --name [string] The name of the new runway group that work will be deployed to
-d, --dissolve [string] The interval in which this group should dissolve from the server
format: time span: 'dd.hh:mm:ss' (date [24 hour]: 'mm/dd/yyyy hh:mm:ss')
date: 'mm/dd/yyyy hh:mm:ss' (24 hour)
none: 'none' (group will be permanent. enrolled agents must be manually removed in the future)
(optional)(default: 30 days)connect
Instance a named data-connection to a local datastore or service
Usage: runway connect [OPTIONS]
Options:
'*' indicates an option field is required
* -n, --name [string] The name of the connection to use
-u, --username [string] The user name used to authenticate to remote machines
(optional)(default: prompt)
-p, --password [string] The password requires to authenticate to remote machines
(optional)(default: prompt)dissolve
Dissolve a named group of endpoints
Usage: runway dissolverun
Run an action over a named group of endpoints
Usage: runway run [-l <path> | <action name>]
Options:
-l, --local Path on disk of a locally built action to runtoken
Generate an enrollment token for endpoints
Generate an enrollment token.
Nodes and endpoints can be enrolled with this token.
Usage: runway token [OPTIONS]
Options:
* -j, --job [id] Add the enrolled node to the specified job
* -g, --group [id] Add the enrolled node to the specified group or folder
* -p, --persistent Make the node a persistent node (i.e, endpoint)
* -c, --cloudworker Make the node a cloud worker node (takes generic work)
* -s, --cloudservice Make the node a cloud service node (runs specific service)
* -e, --ephemeral Don't enroll a node, the runner is volatile (i.e, kubernetes pod)node
Start a runway node relative to the current directory
Starts a runway node in the current directory.
Usage: runway node [OPTIONS]
'runway node' will default to --reuse. If no previous node is detected, it will enroll as type 'endpoint'.
Options:
* -d, --duration [string] The qualified namespace of the target action to download
format: time span: 'dd.hh:mm:ss' (date [24 hour]: 'mm/dd/yyyy hh:mm:ss')
date: 'mm/dd/yyyy hh:mm:ss' (24 hour)
none: 'none' (Worker will continue work until manually cancelled)
(optional)(default: 'none')
* -j, --job [id] Add the node to the specified job
* -g, --group [id] Add the node to the specified group or folder
* -p, --persistent Make the node a persistent node (i.e, endpoint)
* -c, --cloudworker Make the node a cloud worker node (takes generic work)
* -s, --cloudservice Make the node a cloud service node (runs persistent service)
* -e, --ephemeral Don't enroll a node, the runner is volatile (i.e, kubernetes pod)
* -n, --name Request a specific name for the node
* --new Create a new runner node, even if one already exists
* --customid [id] Use a custom asset identity with this node
* -l, --list List the current nodesdiscover
Discovers the network
Usage: runway discover [OPTIONS]
Options:
--json Specify json filename for the asset map information
--icmp Use icmp ping
--syn Use tcp syn
--udp Use udp scan
--other Use additional methods
--range Use ip range, sample: "192.168.0.0/24;10.0-1.0-100.100-255"
--ports Use ports, sample: "443;80"
--wait Defines minimum seconds to wait
--opdelay Defines the delay between connect attempts in millisecondsdownload
Downloads the job results
Usage: runway download [OPTIONS]
Options:
-l, --loop Stay resident looping for results
--directory Directory to store the downloads
-j, --job Download all results for this job id
-t, --thread Specify thread id for download (optional)
--previous Get the previous action's results for this thread id
--prodigal Get the prodigal action's results for this thread iddownload_logs
Downloads the runner logs
Usage: runway download_logs [OPTIONS]
Options:
--runner Specify runner id for download
--group Specify group id for download
--home Use home group for downloadshell
Connects a shell console to the specified remote runner
Usage: runway shell [OPTIONS]
Options:
--runner Runner id
--ip IP Address of runnerstream
Connect or listen the runway stream
Usage: runway stream [OPTIONS]
Options:
--connect Name of stream to connect
--listen Name of stream to listen
--input Input endpoint: pipe://stdin, file://filename, tcp://[address]:port
--output Output endpoint: pipe://stdout, file://filename, tcp://address:port
--nostat Don't show statistics
--persistent Restart the streaming on any error
--timeout Connect/listen timeout: number with s/m/h
--instance Stream instance to handle
--tail Append the output filedatahub
Connect to the datahub
Usage: runway datahub [OPTIONS]
Options:
--connect Name of stream to connect
--input Input endpoint: pipe://stdin, file://filename, tcp://[address]:port
--output Output endpoint: pipe://stdout, file://filename, tcp://address:port
--nostat Don't show statistics
--persistent Restart the streaming on any error
--timeout Connect timeout: number with s/m/h
--delimiter Message delimiter
--chunked Use chunked mode
--write-headers Write headers to endpoints
--headers Specify JSON with additional headers
--tail Append the output filecopy
Copies files to and from remote runners
Usage: runway copy [OPTIONS]
Options:
--runner Runner id
--ip IP Address of runner
--source Source filename
--destination Destination filename
--mode Mode: upload/downloadinstall
Install the runner as a service
Usage: runway install [OPTIONS]
Options:
'*' indicates an option field is required
* -t, --token [string] A valid enrollment token to use for this deployment (see enroll command)
* -n, --name Request a specific name for the nodeuninstall
Uninstall the runner service
Usage: runway uninstall
deploy
Installs a deployed runner
Usage: runway deploy [OPTIONS]
Options:
'*' indicates an option field is required
* -t, --token [string] A valid enrollment token to use for this deployment (see enroll command)
* -d, --deadline [string] The deadline that this deployments should complete by
format: time span: 'dd.hh:mm:ss'
(optional)(default: "7 days")
* -c, --concurrency [int] The limit number of concurrent deployment connections
A higher number results in faster deployments at the cost of additional system resources
(optional)(default: 4, max: 64)
The following are mutually exclusive:
---
-r, --range [string] IP address range for deployment in the format of 192.168.0.1-192.168.0.255
-h, --host [string] The host name or ip address of a single machine to deploy to
(default: 'localhost')
-l, --list [string] path to a file on disk containing a comma seperated list of hostnames
and IP addresses.
---
-u, --username [string] The user name used to authenticate to remote machines
(optional)(default: current user)
-p, --password [string] The password required to authenticate to remote machines
(optional)(default: current user session)upload
Uploads asset map data
Usage: runway upload [OPTIONS]
Options:
--map Upload asset map datajob
Assigns the job to a runner
Usage: runway job [OPTIONS]
Options:
--run Run the job
--ip Endpoint IP Address
--endpoint Endpoint GUID
--jobid Job id
--jobname Job nameLast updated