Terminal
Introduction
Terminal's command structure is as shown below,
<cmd> <what> <name> argument1:"value1" argument2:"value2" ...
cmd
Cmd has following values,
Command | Description |
---|---|
add | Adds a specified what . |
ensure | Ensures that specific what is present , if not present it will add |
goTo | Navigates to a specific contextual what . |
remove | Removes a specific what . |
update | Updates properties of an existing what . |
Displays or prints information on the screen. | |
deploy | Deploys an enterprise pr plugin. |
revertToDeploy | Reverts to a previously deployed enterprise or plugin. |
fromStore | Retrieves or imports an enterprise or plugin from a store. |
invite | Sends an invitation to a specific user, follower, or admin. |
inviteAll | Sends invitations to all users, followers, and admins. |
activate | Activates a user, follower, or admin. |
deActivate | Deactivates a user, follower, or admin. |
ensureSelf | Used to add oneself as a user or follower. |
clear | Clears the terminal commands. |
what
What has following values,
What | Description |
---|---|
action | action description |
actionFormDefaultValue | actionFormDefaultValue description |
actions | actions description |
admin | admin description |
admins | admins description |
automation | automation description |
automationEvent | automationEvent description |
automationStep | automationStep description |
automationStepFormula | automationStepFormula description |
automations | automations description |
deeplink | deeplink description |
deeplinkProp | deeplinkProp description |
deeplinks | deeplinks description |
deployConfig | deployConfig description |
deployEntPlugin | deployEntPlugin description |
deployEntPluginConfigFormValue | deployEntPluginConfigFormValue description |
deployVar | deployVar description |
driveSettings | driveSettings description |
driveSheet | driveSheet description |
driveSheets | driveSheets description |
entPlugin | entPlugin description |
entPlugins | entPlugins description |
enterprise | enterprise description |
field | field description |
fieldPermission | fieldPermission description |
fieldProp | fieldProp description |
fieldRefOverlayLayout | fieldRefOverlayLayout description |
follower | follower description |
followers | followers description |
form | form description |
formFormula | formFormula description |
formLayoutContent | formLayoutContent description |
formLayoutFooter | formLayoutFooter description |
formLayoutHeader | formLayoutHeader description |
formLayoutWatermark | formLayoutWatermark description |
formMenu | formMenu description |
formPermission | formPermission description |
formProp | formProp description |
formVisibilityAction | formVisibilityAction description |
formVisibilityCondition | formVisibilityCondition description |
formVisibilityRule | formVisibilityRule description |
forms | forms description |
gotoCtx | gotoCtx description |
grid | grid description |
gridLayout | gridLayout description |
gridLayoutCardItem | gridLayoutCardItem description |
gridLayoutListItem | gridLayoutListItem description |
gridLayoutTableFooter | gridLayoutTableFooter description |
gridLayoutTableHeader | gridLayoutTableHeader description |
gridMenu | gridMenu description |
gridMenuRow | gridMenuRow description |
gridPermission | gridPermission description |
gridProp | gridProp description |
group | group description |
groupAction | groupAction description |
groups | groups description |
plugin | plugin description |
pluginApi | pluginApi description |
pluginResource | pluginResource description |
prompt | prompt description |
promptConfig | promptConfig description |
prompts | prompts description |
report | report description |
reports | reports description |
role | role description |
roles | roles description |
section | section description |
sectionMenu | sectionMenu description |
sectionPermission | sectionPermission description |
sectionProp | sectionProp description |
spreadsheet | spreadsheet description |
spreadsheetLayout | spreadsheetLayout description |
spreadsheetLayoutCardItem | spreadsheetLayoutCardItem description |
spreadsheetLayoutListItem | spreadsheetLayoutListItem description |
spreadsheetPartition | spreadsheetPartition description |
spreadsheetPermission | spreadsheetPermission description |
spreadsheetPermissionForwardGroups | spreadsheetPermissionForwardGroups description |
spreadsheetPermissionForwardRoles | spreadsheetPermissionForwardRoles description |
spreadsheets | spreadsheets description |
translation | translation description |
translations | translations description |
user | user description |
users | users description |
validations | validations description |
variable | variable description |
variableMapOfTextKeyValue | variableMapOfTextKeyValue description |
variableMappingField | variableMappingField description |
variableMappingGrid | variableMappingGrid description |
variables | variables description |
name
It is a Symbol, which is optional for certain 'what'.
Symbol properties:
- Starts with a capital alphabetic character.
- Does not start with a number.
- Excludes the use of special characters.
argument
Arguments and their values are discussed in detail where required.