Mason Platform CLI v2 (latest)
mason create project
create project on the Mason Platform
Synopsis
This command will create project for the specified Device Family and API Level if they are valid.
mason create project [flags]
Options
--apiLevel API Level apiLevel of the project, valid values are [23, 25, 27, 30]
--description string description of the project
--deviceFamily Device Family deviceFamily of the project, valid values are [D03, F07, D450, D450A, D450B, C210, F210, F450, G430, G450, I3399A, A4100, D215]
-h, --help help for project
-n, --name string name of the project
Options inherited from parent commands
--api-key string Mason Platform API key
mason create
Create commands for create action in Mason Platform
Synopsis
This command will create resources in Mason Platform. See subcommands for details on each resource create action.
Options
-h, --help help for create
Options inherited from parent commands
--api-key string Mason Platform API key
mason deploy apk
deploy an APK to a group
Synopsis
This command will deploy a registered APK to a specific group.
mason deploy apk [flags]
Examples
mason deploy apk --name awesome-app-1 --version 3 --group group2
Options
-g, --group string Group to deploy the artifact to.
-h, --help help for apk
-n, --name string Unique name of the apk to deploy.
-p, --push Push immediately to devices.
-v, --version string Version of the artifact to deploy.
Options inherited from parent commands
--api-key string Mason Platform API key
mason deploy config
deploy a config to a group
Synopsis
This command will deploy a registered config to a specific group.
mason deploy config [flags]
Examples
mason deploy config --name app-config-1 --version 1 --group group3
Options
-g, --group string Group to deploy the artifact to.
-h, --help help for config
-n, --name string Unique name of the apk to deploy.
-p, --push Push immediately to devices.
-v, --version string Version of the artifact to deploy.
Options inherited from parent commands
--api-key string Mason Platform API key
mason deploy ota
deploy an ota to a group
Synopsis
This command will deploy an OTA upgrade to a specific group.
mason deploy ota [flags]
Examples
mason deploy ota --version 2.13.0 --group group3
Options
-g, --group string Group to deploy the artifact to.
-h, --help help for ota
-p, --push Push immediately to devices.
-v, --version string Version of the artifact to deploy.
Options inherited from parent commands
--api-key string Mason Platform API key
mason deploy
deploy existing artifacts to groups on the Mason Platform
Synopsis
This command will deploy artifacts to a specific group. See subcommands for details on deploying each artifact type.
Options
-h, --help help for deploy
Options inherited from parent commands
--api-key string Mason Platform API key
mason get project
get project on the Mason Platform
Synopsis
This command will get project given the project identifier/name.
mason get project [flags]
Options
-h, --help help for project
-n, --name string name of the project
Options inherited from parent commands
--api-key string Mason Platform API key
mason get
Get commands for get action in Mason Platform
Synopsis
This command will retrieve resources in Mason Platform. See subcommands for details on each resource get action.
Options
-h, --help help for get
Options inherited from parent commands
--api-key string Mason Platform API key
mason register apk
register an APK
Synopsis
This command will register an APK with the Platform. It will use the android:versionCode, android:packageName for the APK version and name. These must be unique.
mason register apk [flags]
Options
-f, --file string Relative path to an APK
-h, --help help for apk
Options inherited from parent commands
--api-key string Mason Platform API key
mason register bootanimation
register a Bootanimation
Synopsis
This command will register a Bootanimation with the Platform.
mason register bootanimation [flags]
Options
-f, --file string Relative path to a Bootanimation
-h, --help help for bootanimation
Options inherited from parent commands
--api-key string Mason Platform API key
mason register config
register Mason OS configs
Synopsis
This command will register a Mason config with the Platform.
mason register config [flags]
Options
-f, --file string Relative path to a config yaml file.
-h, --help help for config
Options inherited from parent commands
--api-key string Mason Platform API key
mason register splash
register a Splash image
Synopsis
This command will register a Splash image with the Platform.
mason register splash [flags]
Options
-f, --file string Relative path to a splash image
-h, --help help for splash
Options inherited from parent commands
--api-key string Mason Platform API key
mason register
register artifacts to the Mason Platform
Synopsis
This command will register artifacts with the Mason Platform. See subcommands for details on how to register on artifact type.
Options
-h, --help help for register
Options inherited from parent commands
--api-key string Mason Platform API key
mason xray adbproxy
initiate adb proxy with a remote device
Synopsis
This command will create a connection with a remote device allowing you to connect a locally using adb.
mason xray adbproxy [flags]
Options
-h, --help help for adbproxy
-p, --port string localhost port to listen on (default "5558")
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray delete-file
delete the given file from the remote device
Synopsis
This command will take the supplied file path and delete the file on the remote device.
mason xray delete-file [flags]
Options
-h, --help help for delete-file
-p, --path string file path on remote device
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray describe-log-buffers
describe the log buffers available to read on the device
Synopsis
This command will show more detailed information such as chattiest PIDs for the specified buffer(s) on the device.
mason xray describe-log-buffers [flags]
Options
-b, --buffer string log buffer on remote device to describe (default "main")
-h, --help help for describe-log-buffers
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray get-bug-report
generate and retrieve the bug report from the remote device
Synopsis
This command will generate a bug report on the remote device and return it. Note: generating a bug report can take several minutes.
mason xray get-bug-report [flags]
Options
-h, --help help for get-bug-report
-o, --outputPath string file path to write the output to
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray get-file
get the given file from the remote device
Synopsis
This command will take the supplied filepath and return the file on the remote device.
mason xray get-file [flags]
Options
-h, --help help for get-file
-o, --outputPath string file path to write the output to
-p, --path string file path on remote device
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray get-logs
get the current log buffer on the device
Synopsis
This command will output the current log buffer on the device.
mason xray get-logs [flags]
Options
-b, --buffer string log buffer on remote device to describe (main, system, crash, etc.)
-c, --count int number of log entries to retrieve (default -1)
-h, --help help for get-logs
-l, --level string log level to filter for. (verbose, debug, info, warn, error)
-p, --pid int pid of process to filter logs for (default -1)
-s, --startTime string starting date time to filter logs for (in device's time) accepted formats: 'MM-dd HH:mm:ss.SSS' and 'yyyy-MM-dd HH:mm:ss.SSS'
-t, --tags stringArray list of tags to filter device logs for (usage: -t Tag1 -t Tag2 etc.)
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray get-screen-capture
capture and return the current screen view on the remote device
Synopsis
This command will capture the current screen view on the remote device and return it.
mason xray get-screen-capture [flags]
Options
-h, --help help for get-screen-capture
-o, --outputPath string file path to write the output to (.png file type)
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray install-apk
install the supplied apk on the remote device
Synopsis
This command will take in a local apk file and install it on the supplied device.
mason xray install-apk [flags]
Options
-t, --allowTestApk allow the install of test apks. Default: false
-v, --allowVersionDowngrade allow a version downgrade for the apk. Default: false
-f, --filePath string local path of file to put on remote device
-g, --grantRuntimePermissions grant all permissions listed in the app manifest. Default: false
-h, --help help for install-apk
-r, --reinstall reinstall the apk if already present, keeping all of its data. Default: false
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray list-files
list the given file path on a remote device
Synopsis
This command will take the supplied filepath and list the directory or file on the remote device.
mason xray list-files [flags]
Options
-h, --help help for list-files
-p, --path string file path on remote device
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray logcat
stream logs from a remote device
Synopsis
This command will create a connection with a remote device allowing you to stream logs from it.
mason xray logcat [flags]
Options
-b, --buffer string log buffer on remote device to describe (main, system, crash, etc.)
-h, --help help for logcat
-l, --level string log level to filter for. (verbose, debug, info, warn, error)
-p, --pid string pid of process to filter logs for
-t, --tags stringArray list of tags to filter device logs for (usage: -t Tag1 -t Tag2 etc.)
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray put-file
put the given file path on the remote device
Synopsis
This command will take the supplied filepath and put the given file on the remote device.
mason xray put-file [flags]
Options
-f, --filePath string local path of file to put on remote device
-h, --help help for put-file
-p, --path string file path on remote device
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray uninstall-apk
uninstall the given apk on the remote device
Synopsis
This command will take in an apk name and uninstall it on the supplied device.
mason xray uninstall-apk [flags]
Options
-a, --apkName string name of the apk on the remote device to uninstall
-h, --help help for uninstall-apk
Options inherited from parent commands
--api-key string Mason Platform API key
-d, --deviceId string device UUID
mason xray
X-Ray commands for interacting with devices
Synopsis
This command will interact with devices via X-Ray. See subcommands for details on each X-Ray action.
Options
-d, --deviceId string device UUID
-h, --help help for xray
Options inherited from parent commands
--api-key string Mason Platform API key
mason
Options
--api-key string Mason Platform API key
-h, --help help for mason
-v, --version version for mason