headroom 0.2.1

A powerful, extensible command-line AI assistant.

Max Headroom

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

pip install headroom

---

Usage

Start Max from your terminal:

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:

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

Run locally:

python -m headroom.max

---

License

MIT License. See LICENSE for details.

---

Author

James Bridges

---

Contributing

Pull requests and issues are welcome!

---

Acknowledgements

• prompt_toolkit
• pyyaml
• requests
• python-dotenv

---