CLI Generated Commands

Erik Massop edited this page Nov 4, 2017 · 1 revision

All commands in CLI follow the same structure and needs to be documented in several places:

  • In the code, to provide help when the user type help command or command --help.
  • In the man page.
  • Other places that we didn't think about already.

Right now, command descriptions (including available options) need be dupplicated and kept in sync by hand. A very fastidious work!

This page describes a solution based on an xml-file to be processed to generate setup code and documentation. Another target would also be generated commandline validation to reduce the amount of validation code to write in functions actually running the command.

Generated contents

Command setup code

Command validation code

Commands section in man page

Generator

Formatters

Integration in WAF

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.