Skip to content
This repository has been archived by the owner on Sep 15, 2022. It is now read-only.

Latest commit

 

History

History
58 lines (41 loc) · 1.22 KB

README.md

File metadata and controls

58 lines (41 loc) · 1.22 KB

Design for Dartino Command Line Interface commands

The overall structure of commands in Dartino should follow:

dartino verb [zero or more verbs or object-nouns]

The outermost verb is the group of actions to be performed (for example, 'help'). Subsequent verbs are either 'sub-verbs' (for example, 'debug step') or are the target of the outer verbs (for example 'help debug').

Object-nouns are the target of the command (for example, 'dartino show changes')

The overall aim here is to provide the ability to 'vocalise' the instructions, in other words to say them to yourself as you type them.

Some examples

dartino debug step

should perform the next step of execution.

dartino help

should provide 'top level' help, whereas:

dartino help debug

should provide help about debug.

Exceptions

Help should be supported everywhere as a top level verb and a sub-verb, in other words:

dartino help debug
   and
dartino debug help

Should display the same text.