Skip to content

User Guide

BoettcherDasOriginal edited this page May 28, 2022 · 4 revisions

User Guide

The user guide explains the use of LeoConsole and the standard functions.
It also goes into more detail about how LeoConsole works.

Note: The user guide is currently a work in progress

Contents

First Start

First Start Example

When LeoConsole is started for the first time, it sets itself up. The only thing the user has to do at the beginning is to create a root user. Then only the automatic installation of the default plugins follows and LeoConsole is ready to use!

The User

Each user has a name, a password and a greeting.
The greeting is always displayed after you have logged in.
The username must be unique.

The terminal

Terminal Example

LeoConsole's terminal is quite simple, but supports many functions by default.
Colored Output, multiple arguments, arrow-up history and tab-completion are already implemented.
ILeoConsole.dll also provides all these functions for the plugins.

Plugins and Commands

Plugins

If you want to extend LeoConsole, you can do it through plugins.
You can use plugins developed by others or you can develop your own plugin.
See Plugin Tutorial for more information.

Commands

What is a console without commands? Right, nothing!
Therefore LeoConsole already contains many commands by default!
See Commands for a list of all default commands.

The Save Path

LeoConsole stores all sorts of stuff in its installation directory in the data/ folder.

Data ls

  • pkg/ -> stores data for the default plugin manager
  • plugins/ -> this is where your plugins go
  • tmp/ -> just temporary files
  • trash/ -> the recycle bin
  • user/ -> user information
  • var/ -> general data storage for plugins and configurations
Clone this wiki locally