Config CLI Glossary

Some new concepts are introduced in the initial release of Config CLI, these are described in this brief glossary of Config CLI terms used to define compound command lines.

   
Context The point in the configuration where the shell is active or focused.
Command Line The whole command string that the user typed. Sometimes, the command line may directly translate to a command but sometimes may translate to multiple commands.
Command The action that is to be executed in the current context.
Argument The tokens that are passed to a command. These could be the values being assigned to fields in field updates but may also include array indexes or object keys.
Token The words that make up a command line. These words can be space separated single words or quoted strings like "two words" or mult-iline strings.
Command Line
Category

The overall description of the command line. There are four main types:

  1. simple: simple command lines are compose of single command and with or without an argument, # Some examples:

    • config: user

    • config: show

    • config: top

 
  1. field update: A command line composed of a field-update expression only.

  1. config(user root): description "my description" enabled true
    navigation: A command line made of a navigation expression only,
    meaning config: user root

  1. compound: A command line that starts with an OPERATION and is followed by an optional navigation expression then a field update expression. An operation is anyone of add edit show delete. Some examples are:

  • config: add user bob description "my description" enabled true
  • config: show user bob
  • config: edit user bob description "new description"
  • config: delete user bob
Complex field A field that can be navigated into. These are either array or subobject type. See the Compound Command Line Structure illustration on the following page.

Compound Command Line Structure

The following illustrations assist in visualizing the compound command line concept: