Documentation 👋¶

Penta¶

A cmd/command prompt/shell/command interpreter(whatever you say) purely written in python .tries to be more efficient ,functional and easier to use than our classic cmd. Here is a table of commands that Penta supports as of now.i also converted a part of project into Python2(as an experiment),if you want to check that out just see the Pent2.py.

Note:¶

Please note that commands that have additional argumnents such as ``cd <directory>`` are index sensitive.i.e ``cd MyDirectory`` and ``cd MyDirectory``(with extra space) are interpreted differently.also all the system commands are also supported

Commands:	Description:
cd	Change Directories
list	lists directory Content.use ‘-p’ to list directory content with its permission.
clear,clr,cls	Clear screen
read,type,cat	Read Files
sysinfo/systeminfo	Show system info
rem \	Remove Files and Folders.use ‘-f’ to remove directories that are unempty.
ren/rename \ \	Rename files and directories
mve/move \ \	Move files and directories
cpy <source> \	Copy files and directories
mdir \	Make Directories
title \	Change title of window
dime	Print date and time(ik,that command tho,lol)
username	Print username
ping-host	Ping host,use ‘-t’ to specify the count.default is 4 requests
configip	Shows network info
getip	Show local ip address.use ‘-p’ parameter to get the public ip address.
getmac	Show Mac address
murder <-i>/<-n> \ /\	Kill a process by either its pid(by using -i parameter) or its name(by using -n parameter).
processlist	Show all the processes
shown <-s>/<-r>/<-l> <-t> time	shutdown,reboot or logout system.use -s to shutdown,-r to reboot,-l to logout,-t to set time-out before shutdown.on windows the timout is in seconds where as in linux its in minutes.
chp	Change File permissions.works partially on windows.use octal values from 0-7.More info.Symbolic permissions(i.e:+x,+r,+w) are also supported.
os ver/ os version	Shows OS information.
search/reveal \	Search Files and Folder.
ver/version	Show Penta’s version.
help	Shows this help box.
chistory/ch	Show command history.
gtube <-v>/<-p> -q	Download videos(-v)/playlists(-p) from youtube using available quality.
gfile \ \	Download files from a http server.
troute \	traceroute an host.
rmd \	Read Markdown with syntax highlight!
treelist	lists current directory as a tree
about	About Penta

Download¶

Operating System	Download:
Windows	Penta-Setup.zip
Linux	Penta-linux.zip

Changelog(Versionwise)¶

Date:	Comment:
23-Mar-2021	Initial Release(Beta version)
30-May-2021	Release 1.3.0

CommitTable¶

Date:	Comment:
23-Mar-2021	Initial Release(Beta version)
28-Mar-2021	Bug fix for windows and switched to nuitka for python compilation
01-Apr-2021	Fixed Typos and added ping and traceroute support for Windows
04-Apr-2021	Can now download files from a server
05-Apr-2021	Tab Completion for both Windows and Linux and shows all the processes
30-Apr-2021	Read Markdown and list directories as a tree
22-May-2021	Can detect a git initialized Directory
23-July-2021	Fix some system commands not working and other bugs and can now show pulic ip addresses

–?

Windows installation¶

Penta will only run on windows 10.

Download the setup from link above and execute it.after installing the setup,be sure to add the directory (present in installation Directory) named bin to PATH.

Linux installation:¶

**if you are using bash instead of zsh,then edit Setup.sh and replace .zshrc with .bashrc** Download the zip file from link above and follow following steps

Unzip and file and cd to the directory.
Open terminal here and type chmod +x Setup.sh to give executable permission to script.
Run the script i.e ./Setup.sh
Restart the terminal after installing the setup
Type penta and Have Fun 🥳… #### Manual Installation(if the script doesn’t work):
Unzip the file and copymove the bin ,configs folder and executable named Penta to home directory
Give executable permission to Penta.sh and copymove it to /bin folder(linux bin folder and be sure that its on $PATH)
(Optional)Now edit your .bashrc file and add a alias at the end of it: alias penta=Penta.sh

NOTE Please be sure that your /bin directory is on $PATH.

Uninstallation:¶

Uninstallation in windows is pretty straightforward ,you just uninstall it like other softwares but there is no uninstalller for linux.delete Penta.sh from /bin folder,edit .bashrc file and remove the alias if any. and also remove the folder named bin,configs and Penta from home directory.

Build from source¶

Windows/Linux:¶

Penta can be built from pyinstaller,py2exe and Nuitka. Icon used in Building Penta.

**Nuitka(Recommended)**(User manual):

First install nuitka using pip install Nuitka.
Now open cmd in same Folder as the Project Folder and Type python3 -m nuitka --plugin-enable=tk-inter --windows-icon-from-ico=IconFileIfAnyIfNotThenSkipThisFlag --standalone Penta.py(for linux remove the windows related flags)
For the First time it’s going to take some time depending on your network speed as nuitka installs a gcc compiler,for all the messages press Y.
Your Executable will be compiled in Penta.dist.All the files in the dist folder are necessary to run Penta.if you want to make a single file executable then you can use the –onefile flag but i wouldn’t recommend it.

**Py2exe **:

First install py2exe using pip install py2exe.
Now Create a file named setup.py or whatever.

if you want to add icon then: .. code-block:

from distutils.core import setup
import py2exe
setup_dict = dict(console=[{'script':'Penta.py','icon_resources':[(0,'ICON.ico')]}])
setup(**setup_dict)

Otherwise there is no need to create a dictionary i.e: .. code-block:
```
from distutils.core import setup
import py2exe
setup(console=['Penta.py'])
```
-now use python setup.py py2exe to build it.

**Pyinstaller**

install pyinstaller using pip install pyinstaller
Now just cd to Project Folder and use pyinstaller --icon IconFileIfAny --onefile Penta.py
Your project will be built under the dist directory.

Bug report¶

Found any bug! Report it to me at x-neron@pm.me or open an issue

Contributions:¶

All contributions are welcomed.fork this repo,improve it and pull requests

License¶

Distributed under GPLV3.0

Note:¶

A General documentation is also available at readthedocs.io.Feel free to improve the doc.you can do so by editing this File.