Metadata-Version: 2.4
Name: headroom
Version: 0.2.3
Summary: A powerful, extensible command-line AI assistant.
Author: James Bridges
License: MIT License
        
        Copyright (c) 2025 James Bridges
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/SUNKENDREAMS/headroom
Project-URL: Bug Tracker, https://github.com/SUNKENDREAMS/headroom/issues
Keywords: ai,agent,cli,llm,automation,tools
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
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: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: prompt_toolkit
Requires-Dist: pygments
Requires-Dist: requests
Requires-Dist: pyyaml
Requires-Dist: python-dotenv
Requires-Dist: platformdirs
Dynamic: license-file

# Max Headroom

![Max Logo](https://github.com/SUNKENDREAMS/headroom/raw/main/headroom/assets/Max_Logo.png)

**Max> A Command-line AI Agent**

---

## Overview

**Max** is a powerful, extensible command-line AI assistant. It can:
- Connect to local or cloud based LLMs
- Interpret natural language commands
- Run system tools and shell commands safely (with confirmation)
- Manage files, directories, packages, and more
- Provide interactive chat and planning features

---

## Installation

```sh
pip install headroom
```

---

## Usage

Start Max from your terminal:

```sh
max
```

Type natural language requests or commands, for example:
- `create a new directory called test`
- `copy file.txt to backup/`
- `install package requests`
- `help`
- `exit`

Max will confirm actions before running anything that changes your system and remeber your preferences.

---

## Features

- **Natural Language Understanding:** Ask for actions in plain English.
- **Safe Execution:** Confirmation prompts for system changes.
- **Always Allow/Revocation:** Mark commands as always allowed or revoke them.
- **Tab Completion:** Quickly find available commands.
- **Extensible:** Add your own tools and commands.

---

## Configuration & Customization

- **Config:** Edit `config.yaml` to customize commands and behavior.
- **User Preferences:** Preferences are stored and managed automatically.

---

## Development

Clone the repo and install dependencies:

```sh
git clone https://github.com/SUNKENDREAMS/headroom.git
cd headroom
pip install -e .
```

Run locally:

```sh
python -m headroom.max
```

---

## License

MIT License. See [LICENSE](LICENSE) for details.

---

## Author

James Bridges

---

## Contributing

Pull requests and issues are welcome!

---

## Acknowledgements

- [prompt_toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit)
- [pyyaml](https://github.com/yaml/pyyaml)
- [requests](https://github.com/psf/requests)
- [python-dotenv](https://github.com/theskumar/python-dotenv)

---
