NOTE: all commands are labeled by their actual name in Console. So press Ctrl+F to find what you're looking for!

If you cannot be arsed doing that, inside of Console use the "docs" command.

---

This command is used to edit the configuration programatically.

You can also do this by accessing the config file. (see section "details")

This commands syntax is as follows:

• option-name: The name of the option to edit. (Required, if you cannot find the names, use the optview command.)
• value: The value to assign to said setting. (Required)
• [--create]: If present, this will create a new option. (Optional)

Example usages:

• optedit ui.color.username #FF0000 (will set the username on the prompt to red)
• optedit ui.color.text #FF0000 --create (will create a new key for the default text color, and make it red)
• optedit ui.options.block false (will disable the block after input)

---

This command will list all loaded plugins.

If there are no plugins loaded, it will say so.

---

This command will load a plugin from an absolute path.

The plugin documentation can be found under the "Plugins" section.

Example: load_plugin C:\Users\user\Documents\plugin.dll

NOTE: This command can reload the same plugin. This is useful for debugging.

---

This command will reset your configuration to its defaults.

It requires you to enter a random phrase to confirm the reset. This is to protect you from plugins trying to automatically destroy your config file.

This command will delete the configuration file and re-new it with its defaults.

---

This command will remove a configuration option from the configuration.

The syntax is as follows:

• optrm option-name

If the option does not exist, the command will display a message notifying you of that and return a non-zero exit code.

Otherwise, the option will be removed and the command will return a zero exit code.

---

This command will unload a plugin with a specified ID.

The commands syntax is as follows: unload_plugin plugin_id

To find a plugin ID, you must use the list_plugins command. When a plugin is loaded, it is assigned an entirely random and unique identifier. This is used to identify the plugin when unloading it.

For automation, the find_plugin will display the plugin ID, storing it inside of the "$" environment variable.

---

This command will try to find a plugin base on its name.

If the plugin exists, its name and id are displayed. The environment variable '$' will be set to the plugin id.

This is useful for automation when unloading plugins.

---

This command will output all configuration options.

It will also tell you where the options are saved.

The options are displayed like this:

---

FORMAT: [option-name]: Visual name (Value: option-value)

---

• option-name: The internal name, something like org.plugin.setting
• visual-name: The name displayed to a user, something like Plugin Setting
• option-value: The value of the option, something like true or #FF0000

---

This command will change the active directory. This current active directory can be seen in the prompt.

This command accepts a relative path, which will be relative to the current active directory. It also accepts rooted paths, which will change the directory entirely.

The ../.. syntax is supported, along with ./ syntax. You can use a ~ to navigate to the current users home directory.

Example usage:

• cd ..
• cd ./Desktop
• cd ~/Documents
• cd C:/Windows

---

This command will copy a file or directory to another location.

If the destination is a directory, the file will be copied into the directory. If the destination is a file, the file will be copied over the destination file. If the destination is a directory, and the source is a directory, the source directory will be copied into the destination directory.

If the source does not exist, an error will be displayed and a negative return value is returned. If the destination does not exist, it will be created.

Usage:

• copy [options...]

---

This command will output information about the files & directorys in the current directory. It also accepts an argument which if present will output information about that directory instead.

If the supplied directory does not exist, an error will be displayed.

Example usage:

• dir
• dir C:\Windows

The information displayed is:

• Last access time
• File size (if applicable)
• Directory size (if applicable)
• Name

---

This command will iterate a directory, counting all applicable files and their lines. It can also apply to one file if requested.

The purpose of this command is for programmers, counting the line count in their projects.

Usage:

• -V, --valid-exts: The valid extensions to count.
• -d, --directory: The directory to count files in.
• -r, --recursive: Whether to count files recursively, if present this will count any files within directorys of the current directory supplied by --directory.
• -v, --verbose: Whether to show the current file being counted.
• -f, --file: Whether to count a single file instead of a directory, this and --directory cannot be supplied together.
• -P, --preset: The file extension preset to use. (cpp, c, cs, py, rs) This option will override all other options. It will set the valid extensions to any extension related to that programming language. It will also set the directory to the current working directory. It will recurse & verbose is enabled.

This command is very useful for programmers, counting the line count in their projects.

---

This will output the current working directory in the context of the active terminal instance.

examples:

• pwd -- outputs the active working directory.

---

This command will attempt to remove a directory.

If the argument supplied is relative, the directory removed will be relative to the CWD.

The syntax is as follows:

• rmdir [...options]
• ^^^^ --all: remove the directory without any warnings, will remove all files/directorys within it too.

---

This command will create a file or update an existing files last read date.

Example:

• touch file.txt
• touch new_file.c

NOTE: This command will not create directories.

---

This command will alias a string to a command. These aliases are saved between sessions, and are loaded on startup.

The syntax for this command is as follows:

• alias alias_name="command1 arg1 & command2 arg2"

The string containing the command can contain & to split commands. The above example would execute sequentially, and the result of the last command would be returned.

This: alias test="help --all & echo hello" Would execute the following commands in order:

• help --all
• echo hello

This is unix terminal style syntax. The alias name is the first argument, and the command is the second.

Options:

• --list: will list all aliases
• --remove: will remove specified alias.

---

This will clear the screen buffer. All text will be removed.

---

This command can generate random strings & numbers based on user input.

The options are:

• password: generate a password
• ----- [count: number] - The number of characters for the password to contain.
• integer: generate a random number
• ----- [--long: flag] if present, the number generated will be 64-bit, instead of 32-bit.

Example usages:

• generate password 16
• ^^^ will generate a string of length 16, containing entirely random characters.
• generate integer --long
• ^^^ will generate a 64-bit random integer.

All results are outputted to the console.

---

This command will display the contents of a file. If the file is a source code file, it will be syntax highlighted.

USAGE: vwf ...options

Options:

• --show-tokens: display the generated lexed tokens instead of text

Example:

• vwf test.cpp
• vwf test.c --show-tokens

If the file is not found, the command will fail. The argument can be relative to the current directory, or absolute.

---

This command will display each file in a directory, one by one.

It uses the vwf command to display each file.

The directory can be relative or absolute.

---

This literally just displays 3 lines that display generic information.

---

This command will display a list of all active commands.

Usage:

• help [--all] [--contains=]

Options:

• --all: If this flag is present, all commands will be displayed, including ones loaded from PATH.
• --contains=: If this is present, the command will only output commands where the name includes . This check is case sensitive.

---

This command was removed on 30/09/2023

---

This command will display these documentation snippets inside of the terminal.

Example:

• docs cd

---

This command will output whatever you put in the arguments. This can include environment variables.

The input can also contain markup, which will show colours and styles. This uses this library for this. Learn the format there.

Examples:

• echo [italic red]Hello, World![/]

---

This command simply exits the program.

---

This command will execute an executable file with specified arguments. This command will not attempt to open files using different applications, just executable files. (so ending with .exe (windows), or no extension (gnu))

Example:

• run /bin/ls -l
• run C:\Users\user\Documents\myapp.exe

---

This command will set an environment variable.

Examples:

• set PATH {PATH};C:\Users\project\bin

---

This command will display a list of all running processes on this machine and their process ID.

This command does not take any arguments.

---

This command will attempt to install a known package.

USAGE: pkg-install

• - The name of the package to install. Use pkg-list for a list of packages.

NOTE: This command requires an internet connection to download the package. It also does connect to a remote address to download the installer for specified applications. If you plan on using this, but feel like it may be risky, all download links are available in the source code of this application. They are also displayed when you run the pkg-list command.

---

This command will list all available packages to install.

It will also show the description of the package, and where it is downloaded from.

The packages are displayed like this:

• Name -- DownloadLink

Use the pkg-install command to install a package from this list. Feel free to check the download links before installing a package.

---