Metadata-Version: 2.4
Name: bashexplain
Version: 1.0.0
Summary: A command-line tool to explain Bash commands, errors, and scripts
Author-email: Ashish Singh <ashishsingh.mail26@gmail.com>, Ravi Poddar <ravipoddar2006@gmail.com>
Project-URL: Homepage, https://github.com/singhashish12238-pixel/bash-explain
Project-URL: Bug Tracker, https://github.com/singhashish12238-pixel/bash-explain/issues
Project-URL: Source Code, https://github.com/singhashish12238-pixel/bash-explain
Project-URL: Documentation, https://github.com/singhashish12238-pixel/bash-explain#readme
Keywords: bash,shell,terminal,cli,education,learning,command-line
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Education
Classifier: Topic :: System :: Shells
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: black>=21.0; extra == "dev"
Requires-Dist: flake8>=3.9; extra == "dev"
Requires-Dist: twine>=4.0; extra == "dev"
Requires-Dist: build>=0.10; extra == "dev"

# Bash Explain

A Python-based tool for explaining Bash commands with intelligent parsing, flag recognition, and security analysis. Helps developers understand command syntax and identify potentially dangerous operations.

## Features Implemented

### Command Explanation Engine
- Parses and explains bash commands with detailed breakdowns
- 60+ common commands with descriptions across multiple categories

### Flag & Option Recognition  
- 40+ common flag patterns (e.g., `-a`, `-r`, `-v`, `--help`)
- Automatic meaning identification

### Security Analysis
- Detects 24+ dangerous command patterns
- Warns about destructive operations, unsafe downloads, permission changes
- Identifies fork bombs, system modifications, and more

### Command Parsing
- Extracts flags, arguments, pipes, and redirections
- Classifies argument types
- Handles custom commands

## Technology

- **Language**: Python 3
- **Design**: OOP with `CommandExplainer` class
- **Dependencies**: Standard library only
- **Method**: Pattern matching and rule-based analysis

## Completed

✅ Command explanation engine  
✅ Command & flag database  
✅ Safety pattern detection system  
✅ Command parser & output formatting  
✅ Type hints for code maintainability  

## Coming Soon

🔄 Interactive REPL mode  
🔄 Script file analysis  
🔄 Configuration support  
🔄 Extended command database  

## Authors

- Ashish Singh
- Ravi Poddar
