Using the Command Line

The command Line is the best and intended way to interact with the Cythan Core. It allow the user to execute custom scripts, compile data, and import mods for the Cythan machine.

The command help is a good way to start.

The CommandLineGenerator.py script

The command line work with the CommandLineGenerator.py script, whitch is a custom script that allow easy to create command, with more security.

This does not respect PEP, or conventions, because it use commentary into the command's function to generate the help command and the syntax.

A command can only acces already define command, that's why the help command is last.

You can execute multiple commands by using the ; character. It will split the string of command by every ; (if it isn't in the middle of a quotes)

Commands

The list of commands are:

• next: advance a Cythan machine by X
• debug: show general information about the sytem / a machine
• list: list the programs / machines.
• break: add a breakpoint for debugging.
• compiler: allow to compile BCL (Basic Cythan Language) into Cythan binary
• load: Load a Cythan binary file.
• logs: Getting logs.
• quit: Stopping the terminal
• clear: Clear the screen
• help: show information about the commands / a command.

Aliases replace the command : it is a redirection of a command. Most used command have alises.

Generals commands

Help

The syntax is help [<COMMAND>|cmd], it have aliases ?

• This command list all the commands loaded before the help command.
• help <COMMAND>It will show information about a particular command named , work with the aliases.
• help cmd will show information about the command line.

Quit

The syntax is quit, it have aliases exit and stop

• This command exit the terminal and stop evrything.

Clear

The syntax is clear, it have aliases cls

• This command will print a hundered new line character.

Debuging

Logs

The syntax is logs (read [<COUNT>|last]|setlevel [NAME]), it have aliases log (whitout 's' !)

• logs read <COUNT> allow you to read the last logs of the system.
• logs read last allow you to read all logs of the active system, from his starting point.
• logs setlevel [NAME] allow you to print on the command line some logs. The 'NAME' can be WARNING, ERROR, DEBUG, INFO, TEST. You can type 'ALL' to print all logs, and custom type are allowed. Type logs setlevel to reset to none.

Debug

Break

list

Cythan Manipulation

load

The syntax is logs (read [<COUNT>|last]|setlevel [NAME]), it have aliases log (whitout 's' !)

• logs read <COUNT> allow you to read the last logs of the system.

compiler

next