Metadata-Version: 2.4
Name: harshal
Version: 0.1.0
Summary: A multi-personality, feature-rich companion CLI helper tool
Project-URL: Homepage, https://github.com/YOUR_USERNAME/harshal
Project-URL: Bug Tracker, https://github.com/YOUR_USERNAME/harshal/issues
Project-URL: Source, https://github.com/YOUR_USERNAME/harshal
Author-email: Harshal <your@email.com>
License: MIT
License-File: LICENSE
Keywords: ai,cli,productivity,rich,terminal,tui,typer
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: platformdirs>=4.0
Requires-Dist: prompt-toolkit>=3.0
Requires-Dist: rich>=14.0
Requires-Dist: textual>=0.75.0
Requires-Dist: typer[all]>=0.15
Provides-Extra: ai
Requires-Dist: litellm>=1.40; extra == 'ai'
Provides-Extra: full
Requires-Dist: chime>=0.7; extra == 'full'
Requires-Dist: litellm>=1.40; extra == 'full'
Requires-Dist: psutil>=6.0; extra == 'full'
Requires-Dist: pyperclip>=1.9; extra == 'full'
Provides-Extra: notifications
Requires-Dist: chime>=0.7; extra == 'notifications'
Provides-Extra: system
Requires-Dist: psutil>=6.0; extra == 'system'
Requires-Dist: pyperclip>=1.9; extra == 'system'
Description-Content-Type: text/markdown

# Harshal CLI 🚀

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Support](https://img.shields.io/badge/python->=3.10-blue.svg)](https://www.python.org/)

**Harshal CLI** is a highly interactive, customizable, and feature-rich terminal companion tool. From displaying system stats and system alerts to generating AI prompts and offering motivational quotes, Harshal adapts to your style with custom visual themes, interactive shells, and dynamic personalities.

---

## Features ✨

* **Multiple Personalities**: Switch between `fun`, `serious`, `cyber`, and `cute` modes.
* **Interactive Prompts**: Built on `prompt-toolkit` and styled with `rich` for elegant user feedback.
* **System Utilities**: Copy output to clipboard, get performance statistics, and run system tasks.
* **AI Engine Integration**: Integrated with `litellm` for direct interaction with LLMs.
* **Curated Data Assets**: Local stores of quotes, fortunes, dad jokes, and retro ASCII art.

---

## Installation 📦

You can install Harshal CLI using `pip` or `pipx`:

```bash
# Basic installation (includes UI, Core, and CLI shell)
pip install .

# Install with AI features (litellm)
pip install ".[ai]"

# Install with System utilities (psutil, pyperclip)
pip install ".[system]"

# Install with Notification sounds (chime)
pip install ".[notifications]"

# Install all features
pip install ".[full]"
```

---

## Commands and Usage 🛠️

Once installed, use the CLI via the `harshal` entrypoint:

```bash
# Check version and verify install
harshal --version

# Run the main interactive prompt
harshal run

# Show a random curated quote
harshal quote

# Crack a hilarious dad joke
harshal joke

# Crack open a virtual fortune cookie
harshal fortune

# Print beautiful retro ASCII drawings
harshal ascii --name computer
```

### Options

* `--personality` (`-p`): Set the theme to `fun`, `serious`, `cyber`, or `cute`.
* `--version`: Show version and exit.

---

## Personalities & Themes 🎨

Harshal comes loaded with four pre-configured themes defined in `src/harshal/data/personality.toml`:

1. 🎉 **Fun & Playful** (`fun`): Full of emojis, programmer jokes, and highly excited prompts.
2. 💼 **Professional & Stoic** (`serious`): Direct, concise, objective, and stoic.
3. 💻 **Cyberpunk Hacker** (`cyber`): Neon-green cyberpunk theme talking in terminal nodes and decrypt payloads.
4. 🌸 **Cute & Cozy** (`cute`): Gentle, cozy, supportive text-emoticons `(* ^ ω ^)` and pastel magenta palettes.

---

## Project Structure 📁

```text
harshal/
├── pyproject.toml
├── LICENSE
├── README.md
└── src/
    └── harshal/
        ├── __init__.py
        ├── cli.py            # CLI entrypoint and commands
        ├── core/             # Core settings and state loaders
        ├── commands/         # Subcommand implementation modules
        ├── ui/               # Terminal styling and layout components
        └── data/             # Local JSON & TOML static data files
            ├── ascii_art.json
            ├── dad_jokes.json
            ├── fortunes.json
            ├── personality.toml
            └── quotes.json
```

---

## License 📄

This project is licensed under the MIT License - see the [LICENSE](file:///c:/work/Pypi/harshal/LICENSE) file for details.
