Skip to content

Command Line Usage

Michael Wang edited this page Jul 11, 2022 · 8 revisions

The CLI interface is fairly simple to use. Most functionality comprises of command line arguments. Command line arguments in Cish are parsed from left to right. The first expected flag is a functionality flag, followed by several operand flags depending on the functionality flag.

./cish [functionality flag] -s [source file] -o [output file]
./cish [functionality flag] -s [source file]
./cish [functionality flag]

See more on functionality flags to check whether a source or output is expected.

Functionality Flags

There are four principle functionality flags.

Functionality Flag Expects Source Expects Output
Information/Help -info N/A N/A
Compile -c Expects cish Source Expects Binary Output Destination
Run -r Expects Binary N/A
Compile and Run -cr Expects cish Source N/A
Inspect Dump (from cish binary) -rd Expects Binary N/A
Inspect Dump (after compiling source) -cd Expects cish Source N/A
Note: Debugging is only enabled with the -cr functionality.

Argument/Specifier Flags

To specify an source, use the -s flag followed by a source specifier(ie filepath). To specify an output, use the -o flag followed by an output specifier(ie filepath). Note: that a source doesn't necessarily have to be a cish source or a cish binary. Note: If a source is required, the source specifier and the source is required to be placed before the output specifier and the output file.

Clone this wiki locally