Skip to main content

A dope shell for hackers

Project description

๐Ÿ”ฅ DopeShell

    โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—     โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•—     โ–ˆโ–ˆโ•—     
    โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•     โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘     
    โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—       โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘     
    โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•โ• โ–ˆโ–ˆโ•”โ•โ•โ•       โ•šโ•โ•โ•โ•โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•  โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘     
    โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—     โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—
    โ•šโ•โ•โ•โ•โ•โ•  โ•šโ•โ•โ•โ•โ•โ• โ•šโ•โ•     โ•šโ•โ•โ•โ•โ•โ•โ•     โ•šโ•โ•โ•โ•โ•โ•โ•โ•šโ•โ•  โ•šโ•โ•โ•šโ•โ•โ•โ•โ•โ•โ•โ•šโ•โ•โ•โ•โ•โ•โ•โ•šโ•โ•โ•โ•โ•โ•โ•

Status Platform License Python

A minimalistic, cross-platform shell with custom command mapping


๐Ÿ“– Introduction

DopeShell is a lightweight, custom shell implementation written in Python that provides essential file system operations with a sleek interface. Built with extensibility in mind, it features a modular component architecture and cross-platform compatibility for both Windows and Linux systems.

โœจ Key Features

  • ๐Ÿ–ฅ๏ธ Cross-Platform - Works seamlessly on Windows and Linux
  • ๐Ÿ—๏ธ Modular Design - Clean separation with engine/components structure
  • ๐ŸŽจ Custom Commands - Intuitive command names for common operations
  • ๐Ÿ”ง Extensible - Easy to add new commands via component system
  • โšก Lightweight - Minimal dependencies, maximum performance

๐Ÿ› ๏ธ Installation

Install via Pip (Recommended)

You can easily install DopeShell using pip:

pip install dopeshell-cli

Manual Installation (For Development)

  1. Clone the repository

    git clone https://github.com/muhammadhaseebiqbal-dev/dopeshell.git
    cd dopeshell
    
  2. Install dependencies

    pip install .
    
  3. Run DopeShell

    dopeshell
    

๐Ÿ“ Command List

Basic Commands

Command Format Description
sd sd List all files and folders in the current directory
fd fd <path> Change directory to the specified path (relative or absolute)
wd wd Display the current working directory path
whoami whoami Display the current user account name
wipe wipe Clear the console screen
halt halt Exit and terminate the current shell session

File Operations

Command Format Description
proc proc <file> Read and display file contents
proc proc -n <file> Read file with line numbers
proc proc <file1> <file2> >>> <output> Concatenate multiple files into one
proc proc > <file> Write user input to a file (overwrite)
proc proc >> <file> Append user input to a file

File Management

Command Format Description
cpy cpy <source> <destination> Copy file or directory from source to destination
mov mov <source> <destination> Move file or directory from source to destination
rn rn <old_name> <new_name> Rename files or folders
snap snap <path> Delete files or directories

Network Commands

Command Format Description
ping ping <host> Test network connectivity to a host
curl curl <url> Fetch and display content from a URL
dsp dsp <url> Download file from URL (DopeShell Package Manager)

Help

Command Format Description
--helpme --helpme Display list of all supported commands

๐Ÿ’ก Usage Examples

# Navigate to a directory
fd Documents

# List files
sd

# Read a file
proc myfile.txt

# Copy a file
cpy file.txt backup/file.txt

# Move a file
mov file.txt documents/file.txt

# Rename a file
rn oldname.txt newname.txt

# Delete a file
snap unwanted.txt

# Check network connectivity
ping google.com

# Download a file
dsp https://example.com/file.zip

๐Ÿค Contributing

Want to contribute? Check out our CONTRIBUTING.md for guidelines on how to help improve DopeShell!


๐Ÿ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.


๐Ÿ‘จโ€๐Ÿ’ป Author

Muhammad Haseeb Iqbal
GitHub: @muhammadhaseebiqbal-dev

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dopeshell_cli-0.1.0.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dopeshell_cli-0.1.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file dopeshell_cli-0.1.0.tar.gz.

File metadata

  • Download URL: dopeshell_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for dopeshell_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 269bf246a376d64be53d26113d03c499b251ba8b32bfe98bcd1b34d2c0169c62
MD5 a22987d9fa791855b3e4518836cae12d
BLAKE2b-256 0788b4295af0371cd1d9da54fbc13d6bf2eb7a87c0f45a6d4198340731d33629

See more details on using hashes here.

File details

Details for the file dopeshell_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dopeshell_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for dopeshell_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6458b0bbfb097dafe55c0ca3a86cb19795445c125fc7af0c0ea1e1344c82f9ce
MD5 5b0b5e065bac83773f667b226117b2a8
BLAKE2b-256 99b0fe5075f18b39518e7d5bfa08a44788ae3f10a58520638a6ebb10bce791c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page