logo Github Projects Zalanwastaken

Command Documentation

This documentation provides details about the available commands, their usage, and exit codes.

Press Ctrl+Shift+C in typer to open command palate

Enabled Commands

    local enabledcommands = {
        ["open"] = true,
        ["exit"] = true,
        ["dev"] = false,
        ["find"] = false,
        ["pls"] = true,
        ["alias"] = true
    }
    

Command Descriptions

open

Opens a file from the saves directory and initializes it.

Usage:
open <filename>

Example:
open example_save.txt
    

exit

Exits the application or switches to a default save file.

Usage:
exit [--typer]

Example:
exit --typer
    

dev

Enables or disables developer mode.

Usage:
dev enable | disable

Example:
dev enable
dev disable
    

find (broken)

Searches for a word in the default save data (currently broken).

Usage:
find <word>

Example:
find hello
    

pls

Forces execution of a command even if it is not enabled.

Usage:
pls <command> [args]

Example:
pls open example_save.txt
    

alias

Creates an alias for a command. The alias can optionally be disabled upon creation.

Usage:
alias <existing_command> <alias_name> [--disable]

Example:
alias open load
alias open load --disable
    

Exit Codes

0 == exited successfully 
1 == general error(Check command output message)
2 == not implemented