Skip to content

dchun01/BCP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BCP - Bash, Command Prompt & PowerShell Reference

An interactive command-line reference tool for Bash, Command Prompt, and PowerShell commands. Get detailed documentation, syntax, examples, and options for terminal commands.

Features

  • Clean, easy-to-navigate menus
  • Detailed descriptions, syntax, and examples
  • Find commands by category
  • Practical usage scenarios with explanations
  • File operations, text processing, system info, and more
  • Pure Python implementation. No dependencies.

Currently Supported

Bash Commands

  • File Operations: ls, cp, mv, rm, mkdir, rmdir, find, locate
  • Text Processing: grep, sed, awk, cat, sort, uniq, cut, tr, wc
  • System Information: ps, top, htop, df, du, free, uname, uptime, whoami, id
  • Process Management: kill, killall, pkill, jobs, bg, fg, nohup, screen, tmux, pgrep

Coming Soon

  • Command Prompt (Windows CMD)
  • PowerShell

Installation

  1. Clone the repository:
git clone https://github.com/dchun01/BCP.git
cd BCP
  1. Run the program:
python bcp.py

Usage

Simply run the program and navigate through the interactive menus:

$ python bcp.py

Navigation

  • Use number keys to select options
  • Navigate through categories and commands
  • Press Enter to continue after reading command details
  • Use Ctrl+C to exit at any time

Example Workflow

  1. Select "1. Bash" from the main menu
  2. Choose "2. Text Processing"
  3. Select "1. grep" for detailed information
  4. View comprehensive documentation with examples
  5. Press Enter to return to the category menu

Screenshots

============================================================
Bash, Command Prompt & PowerShell Command Reference
============================================================
1. Bash
2. Command Prompt
3. PowerShell
4. Exit
============================================================

Enter your choice (1-4): 1

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Ways to Contribute

  • Add Command Prompt commands and documentation
  • Add PowerShell commands and documentation
  • Improve existing documentation
  • Fix bugs or add features
  • Improve the user interface
  • Add tests

Project Structure

BCP/
├── bcp.py              # Main application
├── README.md           # This file
├── LICENSE             # MIT License
├── CONTRIBUTING.md     # Contribution guidelines
└── .gitignore         # Git ignore file

Requirements

  • Python 3.6 or higher
  • No external dependencies required

License

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

Roadmap

  • Complete Command Prompt implementation
  • Complete PowerShell implementation
  • Add search functionality across all commands
  • Add command history/favorites
  • Export command reference to different formats
  • Add configuration options

Support

If you find this tool helpful, please consider:

  • Starring the repository
  • Reporting bugs
  • Suggesting new features
  • ontributing code or documentation

Made for developers, sysadmins, and command-line enthusiasts who want quick access to comprehensive command documentation.