Understand RCC's Global Options - Rocketman-Tech/rcc GitHub Wiki

Rocketman Command Center (RCC) is a versatile CLI tool that provides multiple functionalities through various sub-tools. These tools can be invoked using a specific structure:

rocketman [global-options] <tool-name> [tool-specific-options]

Here’s how it works:

1. Global Options: These apply to the RCC program as a whole.
2. Tool Selection: Specify the tool you want to use (e.g., TemporaryAdmin, UserPrivilegeManagement).
3. Tool-Specific Options: Arguments or parameters that apply only to the selected tool. For detailed information on each tool’s specific options, refer to its documentation in the sidebar.

For example, to run the ListAllFileVaultEnabledUsers tool with the DEBUG-level logging option:

rocketman -l DEBUG ListAllFileVaultEnabledUsers

-v, --version

Displays the version of the Rocketman Command Center.

• Default: false
• Type: boolean
• Example:

  rocketman -v
  

-o, --output

Specifies an additional log file location, in addition to the default logging at /var/log/rocketman.log.

• Default: None
• Type: string
• Example:

  rocketman -o /path/to/logfile.txt <tool-name>
  

-l, --log

Sets the console logging level for the program. Available levels are DEBUG, INFO, WARNING, ERROR, SILENT.

• Default: INFO
• Type: string
• Example:

  rocketman -l SILENT <tool-name>
  

-b, --background

Runs the program in background mode.

• Default: false
• Type: boolean
• Example:

  rocketman -b <tool-name>
  

--plist

Specifies the path to a .plist file for populating arguments.

• Default: /Library/Managed Preferences/{domain}.plist
• Type: string
• Example:

  rocketman --plist /path/to/config.plist <tool-name>
  

-p, --priorities

Defines the priority order of argument sources to determine which source overrides another when the same argument is defined in multiple sources. By default, the order is plist, local, argv, where plist is overwritten by local is overwritten by argv.

• Default: ['plist', 'local', 'argv']
• Type: array
• Example:

  rocketman -p argv local plist <tool-name>
  

Options can be entered in several formats depending on their requirements:

• Single toggle options (like --background) do not require additional values. These are also referred to as boolean options
• Options expecting a single value may be entered in any of the following formats:
  • --key value
  • --key "value with spaces"
• Options expecting multiple values (sometimes referred to as an array). The following formats are considered equal:
  • --key value01 value02 value03
  • --key "value 01" "value 02" "value 03"

Ensure that all paths and options with spaces are enclosed in quotation marks.

• DEBUG level logging can always be found at /var/log/rocketman.log
• RCC installs itself and creates a global rocketman command alias, allowing you to invoke it from any location within Terminal.