experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README changes

Browse source
This commit is contained in:
Olof hagsand 2019-02-13 15:32:39 +01:00
parent 54626aaae4
commit 9fc8ac2e8e
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -154,19 +154,21 @@ The Clixon CLI uses [CLIgen](http://github.com/olofhagsand/cligen) best describe
Clixon adds some features and structure to CLIgen which include: Clixon adds some features and structure to CLIgen which include:
* A plugin framework for both textual CLI specifications(.cli) and object files (.so) * A plugin framework for both textual CLI specifications(.cli) and object files (.so)
* The CLI specification follows CLIgen syntax with some extensions given below. * Object files contains compiled C functions referenced by callbacks in the CLI specification. For example, in the cli spec command: `a,fn()`, `fn` must exist oin the object file as a C function.
* Object files contained compiled C functions which may be referenced by CLI specification _callbacks_. A CLI API struct is given in the plugin. See [example](example/README.md#plugins). * A CLI API struct is given in the plugin. See [example](example/README.md#plugins).
* The CLI specification is enhanced with the following CLIgen variables: * A CLI specification file is enhanced with the following CLIgen variables:
* `CLICON_PROMPT` is a string describing the CLI prompt using a very simple format with: `%H`, `%U` and `%T`. * `CLICON_MODE`: A colon-separated list of CLIgen `modes`. The CLI spec in the file are added to _all_ modes specified in the list.
* `CLICON_PLUGIN` is the name of the object file containing callbacks in this file. * `CLICON_PROMPT`: A string describing the CLI prompt using a very simple format with: `%H`, `%U` and `%T`.
* `CLICON_MODE` A colon separated list of CLIgen `modes` where the syntax in this file is added. * `CLICON_PLUGIN`: the name of the object file containing callbacks in this file.
* Clixon may generate a command syntax from the Yang specification which can be refernced as `@datamodel`. This is useful if you do not want to hand-craft CLI syntax for configuration syntax. Example:
* Clixon generates a command syntax from the Yang specification that can be refernced as `@datamodel`. This is useful if you do not want to hand-craft CLI syntax for configuration syntax. Example:
``` ```
set @datamodel, cli_set(); set @datamodel, cli_set();
merge @datamodel, cli_merge(); merge @datamodel, cli_merge();
create @datamodel, cli_create(); create @datamodel, cli_create();
show @datamodel, cli_show_auto("running", "xml"); show @datamodel, cli_show_auto("running", "xml");
``` ```
The commands (eg `cli_set`) will be called with the first argument an api-path to the referenced object.
* The CLIgen `treename` syntax does not work. * The CLIgen `treename` syntax does not work.
### Large CLI specifications ### Large CLI specifications