Arguments

Arguments follow the name of the command and are used to give options to run the command itself. Separe each argument with a space.

Example of a command executed successfully with all the required arguments. Each argument is highlighted with a different color for clarity.

Required arguments

Required arguments need to be input for the command to work correctly. You will receive an error message or a warning otherwise.

In this guide, required arguments are marked as <argument> with the angle brackets. It is important to not put the angle brackets in the actual command, as they are used as a placeholder to indicate an argument is required.

As you can see, the angle brackets cause the input to be different, so the command won't work.

Optional arguments

Optional arguments are not needed for a command to work, but they may be used to provide additional information or add extra details to a command. In this guide, they are marked as [argument], with the square bracket not needed.

Optional arguments with spaces

They are marked with [...argument] in this guide. They are joined together and allow spaces in there, unlike other arguments that break up on spaces.

The reason for the warning is optional and allows spaces, as marked in green in the above image.

Options

Unlike other arguments, options are not variables, but are needed for commands that have multiple purposes and tell them exactly what to do. Options are usually required, and can be followed by other arguments.

Options are marked with the notation (option1|option2|option3). This means you must write exactly option1, option2, option3. They are case-insensitive.

The argument highlighted in green is an option. This command requires an additional argument as shown in yellow.

‚Äč