Skip to content

Latest commit

 

History

History
304 lines (211 loc) · 6.69 KB

cli.md

File metadata and controls

304 lines (211 loc) · 6.69 KB

aclii command line manual

aclii

A toolkit for aclii (Anti Command Line Interface Interface)


aclii, The toolkit for abstract command line interface interface This command line tool takes a simple descriptive configuration file and generates a command line option parser for bash, a completion script, and other useful tools.

(This command itself will show help and quit. Use subcommands for actions.)

Usage

aclii [--file (path to config file)] [--verbose]

Options

file

--file (default: "./aclii.yml") Specify the file path to your aclii config file (aclii.yml)

verbose

--verbose

Sub Commands

aclii put

Put aclii artifacts into specified place.


Writes artifacts based on the config file to the specified file. Writing to the file is automatically aborted if an error occurs or if a problem is found in the deliverable. For general use, this put command should be used.

(This command itself will show help and quit. Use subcommands for actions.)

Usage

aclii put

Inherited Options

Sub Commands

aclii put launcher

Put an auto generated launcher If specified file already exists, aclii will replace the content with new version.

Usage

aclii put launcher target-file(file)

Arguments

target-file

File path to be put/replaced newly rendered aclii launcher

Inherited Options

aclii put completion

Put an auto generated completion script. If specified file already exists, aclii will replace the content with new version.

Usage

aclii put completion [--target (target)] target-file(file)

Arguments

target-file

File path to be put/replaced newly rendered aclii auto-completion script

Options

target

--target <completionTarget(bash|zsh)> (default: "bash")

Inherited Options

aclii put parser

Put an auto generated arg parser for bash scripts, If specified file already exists, aclii will replace the content with new version.

Usage

aclii put parser target-file(file)

Arguments

target-file

File path to be put/replaced newly rendered arg parser

Inherited Options

aclii put manual

Put a manual file in markdown format

Usage

aclii put manual target-file(file)

Arguments

target-file

File path to be put/replaced newly rendered manual markdown file

Inherited Options

aclii render

Render bash scripts generated from yaml config file. See sub commands for details.


Render generated contents to STDOUT, for testing. You can choose one of sub command from the list.

(This command itself will show help and quit. Use subcommands for actions.)

Usage

aclii render

Inherited Options

Sub Commands

aclii render completion

Render and print bash auto-completion script to STDOUT.

Usage

aclii render completion [--target (target)]

Options

target

--target <completionTarget(bash|zsh)> (default: "bash")

Inherited Options

aclii render launcher

Render and print bash script to launch other program to STDOUT.

Usage

aclii render launcher

Inherited Options

aclii render parser

Render and print rendered bare commandline parser, for testing.

Usage

aclii render parser

Inherited Options

aclii render manual

Render and print manual of entire commands, in markdown format.

Usage

aclii render manual

Inherited Options

aclii playground

Sub commands of this playgrond do nothing but just echo the command line inputs as parsed JSON, as main program would receive.


The subcommands under playground contain command line parsing and inline scripting demos for the launcher.

(This command itself will show help and quit. Use subcommands for actions.)

Usage

aclii playground

Inherited Options

Sub Commands

aclii playground hungry

Eat all args into .argv. This is default behavior for commands which have no sub commands.

Usage

aclii playground hungry genre(foodgenre) food(string)...

Arguments

genre (chinese|french|japanese|ethnic)

Select genre you want to...

food

Inherited Options

aclii playground stuffed

Raise error if non optional values ( started by dash(es) ) are related.

Usage

aclii playground stuffed

Inherited Options

aclii playground run-ls-script

Inline script demo. You can implement any script in aclii file and execute it instead of main program.

Usage

aclii playground run-ls-script

Inherited Options

aclii aclii-completion

render completion script for aclii


Prints completion scripts of aclii itself.

Usage

aclii aclii-completion [--target (target)]

Options

target

--target <completionTarget(bash|zsh)> (default: "bash")

Inherited Options