Skip to content

Command prompt

TheoTechnicguy edited this page Jul 9, 2020 · 1 revision

Besides executing the script by running it simply, you can parse arguments by running it in a command prompt.

Usage

You execute the program simply by sending the command cis_win-[version].exe. This command will run the program in default mode. You can also parse arguments to change the behaviour of the program.

Arguments

Arguments are pieces of information supplied to the program to complete its task. There are different kinds of arguments you can pass to the program.

Required positional arguments

Required arguments are necessary arguments without which the program cannot execute properly. Positional means that their position is important and predefined. Currently, there are no required positional arguments.

Optional positional arguments

Optional arguments are extra arguments to enhance the behaviour of the program. If it isn't supplied, the program will use a default value. Currently, there are no required positional arguments.

Optional arguments

Optional arguments are not optional positional arguments. They do not have a predefined position, but rather rely on a prefix to get the value. Like optional positional arguments, they are substituted by default values when no arguments are given.

Argument Description
-h, --help Help message
--cfg [path] Change cfg location

Help message

usage: cis_win-0.1.3.exe [-h] [--cfg CFG]

optional arguments:
  -h, --help  show this help message
  --cfg CFG   Optional config file location.
Clone this wiki locally