Skip to main content

🔥 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
ld ld List all files and folders in the current directory
sd sd <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
sd Documents

# List files
ld

# 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

Metadata

Release files for dopeshell-cli 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dopeshell-cli 0.1.1
File Size Uploaded
dopeshell_cli-0.1.1.tar.gz 12.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dopeshell-cli 0.1.1
File Interpreter ABI Platform
dopeshell_cli-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 23.3 kB

Release files / dopeshell_cli-0.1.1.tar.gz

Download URL dopeshell_cli-0.1.1.tar.gz
Size 12.0 kB
Tags Source
SHA-256 checksum
How to use checksums
bfe5055cb1f2ffcebab4b1caf30866d2b35154bda99e467aff17dbcfa966bbc7
BLAKE2b-256 checksum
How to use checksums
9921d35d92f43a019e8b1ebfad4493f71bf37de13ef5afeec5756c4e0feb1074
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release files / dopeshell_cli-0.1.1-py3-none-any.whl

Download URL dopeshell_cli-0.1.1-py3-none-any.whl
Size 11.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4bd1072a0ed61a52b149ef06fe80ac804e7c55a2b393caf5838bdbc338fb1409
BLAKE2b-256 checksum
How to use checksums
100b7f021b161d5f34cc988a1f37d128235a626b7911570196f2408f3140f22a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page