Project shadow is a simple command line based system navigation tool.
It has the ability to perform file explorer functions, google searches and has a terminal.
It also has it's own file system, in tne form of the filesys folder, that it can navigate independantly.
To install all dependancies, use the requirements.txt file to install the pip packages required.
You will need to have the latest version of python installed, and for full functionality, have nano installed on your system.
Warning: WINDOWS IS NOT SUPPORTED AS THIS PROGRAM REQUIRES TOUCH. PLEASE USE THE DOCKER VERSION!
For windows, follow this tutorial,
and for linux, use sudo apt install nano.
There are different prompts for each 'app'. They are as follows:
/~# home
$~# files
]~# google
@~# terminal
E~# Email
To boot, you can either import app in a python program or terminal, or use the click cli interface.
For more information, use python3 shadow.py --help in the root directory.
The homepage commands are as follows:
1 File explorer
2 Google Search
3 Terminal
4 Email
g Help
exit Closes Shadow
clear Clears screen
exit Exits script
Any unlisted commands will return unrecognised.
The file explorer commands are as follows:
ls lists all files
nano open text editor
cd change dir
rm/remove remove files or dirs
add/touch add a file
mkdir add a dir
play play an mp3 (untested)
clear clear screen
exit goes back to home
Unless you are in root directory, if you use exit the system will exit with a file not found error. This is normal. Make sure that you are in the root dir before exiting the file explorer
When 2 is entered, it will come up with a different prompt from home. This function will only search for urls.
When a url is entered, it will open your primary browser and redirect to that url. There are no special commands
or flags for this function. You do not need to input https://
The terminal will work the same as a normal linux terminal, with limited functionality. The cd and sudo commands will not work, and exit will go back to the homepage. Clear works in the same way, except for the top of the 'app'.
The email client is a simple email client using smtplib and some dubious code. To use, type sendmail or send into the terminal and follow the prompts.
Warning: The file attachment will grab files from the root directory as opposed to the filesystem.
The system will run regardless of permission and file placement. All of the files must remain in the same folder for the system to work. You can substitute the txt files for anything, as long as they are named the same. The load file and msg.txt come from this repository, and the amount of start prompts can be tweaked in the shadow.py file on line 8.
The whole system is a callable function, as are all the apps. They can be called by:
shadow.boot() Boot the whole system
app.bootscr() Load the bootscreen
app.home() Load the homepage
app.files() Load the file manager
app.google() Load the search engine
app.terminal() Load the terminal
app.email() Load the email client
load.msg() Generate prompts
They are all standalone and should work without the rest of the system. These are also all accesible from the shadow.py file NOTE: Upon exit, the function returns and ends the while loop. it does not call another function When home calls a function, it does not return until it exits.
The optional dockerfile will build a fully dockerised version of project shadow. you can build and run it using these commands:
docker build . -t shadow
docker run -it --rm --name shadow shadow
The dockerfile will be available publicly as voidarc/shadow on docker hub.