Skip to content

User Documentation

Abdirahiim Yassin edited this page Nov 24, 2021 · 12 revisions

Welcome to the User documentation of ShadowOS 👋🏾

Here you'll find:

  • Commands and what they do
  • Error codes and what they stand for
  • How to choose your language at startup
  • And how to install and try out ShadowOS

Commands

Shadow OS is a command-line OS, which means every feature is only accessible through the terminal. Here are the different commands and their corresponding explanation.

commands

Reboot

The reboot command reboots the system

Command: reboot

Shutdown

The shutdown command shutdowns the system

Command: shutdown

Clear

The clear command clears the screen

Command: clear

Log

The log command displays the different logs.

Commands:

They are classified into:

  • Kernel logs
  • System(non-kernel) logs
  • App logs

Kernel log

Kernel logs display the errors in the kernel.

command: log --system

System(non-kernel) log

System logs display the non-kernel errors that take place at the core of the system.

Command: log --normal

App log

App logs display the errors of apps when they suddenly crash.

Command: log --app

Systeminfo

The systeminfo command fetches the system details

Command: systeminfo

Diskinfo

The diskinfo command fetches the disk details

Command: diskinfo

Dir

The dir command allows you to list all the maps and files of the current directory.

Command: dir

CD

The CD command allows you to navigate to your desired path.

It has three options:

  • cd [directory]
  • cd .. -> get back to the previous directory
  • cd / -> get back to the primary drive

Del

The del command deletes a specific file

Command: del

Touch

The touch command allows you to create a file.

Command: touch

Rmdir

The rmdir deletes a specific directory.

Command: rmdir

Mkdir

The mkdir command can create a directory.

Command: mkdir

Miv

The miv command opens the MIV program; which is a simplistic vim editor.

Command: miv

Snake

The snake command opens the snake game.

Command: snake

Cryptotool

The cryptotool command allows you to get the md5 or sha256 hash of a given input.

Command: cryptotool


Error codes

File system error codes

These are the error codes that are related to the file system.

200: When something goes wrong with the Dir command.

201: When something goes wrong while creating a new file.

203: When something goes wrong while deleting a file.

204: When something goes wrong while deleting a directory.

205: When something goes wrong with the CD command.

206: When something goes wrong while reading a file.

207: When something goes wrong while creating a directory.

System codes

These are the error codes related to the System commands.

300: When something goes wrong with the shutdown process.

301: When something goes wrong with the reboot process.

302: When something goes wrong while fetching the system information.

303: When something wrong while fetching the disk information.

304: When something goes wrong while fetching the logs.

Terminal codes:

500: When something goes wrong with the clear command. 501: When something goes with the help command.


Installing ShadowOS

Download VMWare, install and run it.

Now click on "Create a new virtual machine", select ShadowOS' latest released ISO file downloaded from this page and click the "Next" button.

Now click on "Other" for "Guest operating system" and "Other" for version, click "Next" again, select "Store virtual disk as a single file" and select "Finish".

The Virtual File System won't work so go to "C:\Users\username\Documents\Virtual Machines\Other" and replace the "Other.vmdk" with this file.

Now you can select Aura (Other) and click on "Play Virtual Machine".

This section was taken from the Aura project