📁 Reference
Terminal

Terminal

Introduction

Terminal's command structure is as shown below,

 <cmd> <what> <name> argument1:"value1" argument2:"value2" ...

cmd

Cmd has following values,

CommandDescription
addAdds a specified what.
ensureEnsures that specific what is present , if not present it will add
goToNavigates to a specific contextual what.
removeRemoves a specific what.
updateUpdates properties of an existing what.
printDisplays or prints information on the screen.
deployDeploys an enterprise pr plugin.
revertToDeployReverts to a previously deployed enterprise or plugin.
fromStoreRetrieves or imports an enterprise or plugin from a store.
inviteSends an invitation to a specific user, follower, or admin.
inviteAllSends invitations to all users, followers, and admins.
activateActivates a user, follower, or admin.
deActivateDeactivates a user, follower, or admin.
ensureSelfUsed to add oneself as a user or follower.
clearClears the terminal commands.

what

What has following values,

WhatDescription
actionaction description
actionFormDefaultValueactionFormDefaultValue description
actionsactions description
adminadmin description
adminsadmins description
automationautomation description
automationEventautomationEvent description
automationStepautomationStep description
automationStepFormulaautomationStepFormula description
automationsautomations description
deeplinkdeeplink description
deeplinkPropdeeplinkProp description
deeplinksdeeplinks description
deployConfigdeployConfig description
deployEntPlugindeployEntPlugin description
deployEntPluginConfigFormValuedeployEntPluginConfigFormValue description
deployVardeployVar description
driveSettingsdriveSettings description
driveSheetdriveSheet description
driveSheetsdriveSheets description
entPluginentPlugin description
entPluginsentPlugins description
enterpriseenterprise description
fieldfield description
fieldPermissionfieldPermission description
fieldPropfieldProp description
fieldRefOverlayLayoutfieldRefOverlayLayout description
followerfollower description
followersfollowers description
formform description
formFormulaformFormula description
formLayoutContentformLayoutContent description
formLayoutFooterformLayoutFooter description
formLayoutHeaderformLayoutHeader description
formLayoutWatermarkformLayoutWatermark description
formMenuformMenu description
formPermissionformPermission description
formPropformProp description
formVisibilityActionformVisibilityAction description
formVisibilityConditionformVisibilityCondition description
formVisibilityRuleformVisibilityRule description
formsforms description
gotoCtxgotoCtx description
gridgrid description
gridLayoutgridLayout description
gridLayoutCardItemgridLayoutCardItem description
gridLayoutListItemgridLayoutListItem description
gridLayoutTableFootergridLayoutTableFooter description
gridLayoutTableHeadergridLayoutTableHeader description
gridMenugridMenu description
gridMenuRowgridMenuRow description
gridPermissiongridPermission description
gridPropgridProp description
groupgroup description
groupActiongroupAction description
groupsgroups description
pluginplugin description
pluginApipluginApi description
pluginResourcepluginResource description
promptprompt description
promptConfigpromptConfig description
promptsprompts description
reportreport description
reportsreports description
rolerole description
rolesroles description
sectionsection description
sectionMenusectionMenu description
sectionPermissionsectionPermission description
sectionPropsectionProp description
spreadsheetspreadsheet description
spreadsheetLayoutspreadsheetLayout description
spreadsheetLayoutCardItemspreadsheetLayoutCardItem description
spreadsheetLayoutListItemspreadsheetLayoutListItem description
spreadsheetPartitionspreadsheetPartition description
spreadsheetPermissionspreadsheetPermission description
spreadsheetPermissionForwardGroupsspreadsheetPermissionForwardGroups description
spreadsheetPermissionForwardRolesspreadsheetPermissionForwardRoles description
spreadsheetsspreadsheets description
translationtranslation description
translationstranslations description
useruser description
usersusers description
validationsvalidations description
variablevariable description
variableMapOfTextKeyValuevariableMapOfTextKeyValue description
variableMappingFieldvariableMappingField description
variableMappingGridvariableMappingGrid description
variablesvariables 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.