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 testcopy file.txt to backup/install package requestshelpexit
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.yamlto 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
Metadata
Release files for headroom 0.2.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| headroom-0.2.7.tar.gz | 5.3 MB | Without provenance | Details for headroom-0.2.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| headroom-0.2.7-py3-none-any.whl | Python 3 | none | any | Details for headroom-0.2.7-py3-none-any.whl |
Total release size: 10.6 MB
Release files / headroom-0.2.7.tar.gz
| Download URL | headroom-0.2.7.tar.gz |
|---|---|
| Size | 5.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11fc22b131e0794fefc112d218da70eddd0f7b8ef3bf153a17fb6675420a735e
|
|
BLAKE2b-256 checksum How to use checksums |
b09093b80287b2fce03e379092324d98d8360046b4caec505ebb25200dc64f96
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Release files / headroom-0.2.7-py3-none-any.whl
| Download URL | headroom-0.2.7-py3-none-any.whl |
|---|---|
| Size | 5.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c755e9c2e15f1e3c67041dd31f6d28814089608453c61721faec2a4dec9b1bfc
|
|
BLAKE2b-256 checksum How to use checksums |
933f5382e22d8da9c5e959ceafe2c8cc81f5afbeaffb5f4627101e2ce2dc7466
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Security for headroom 0.2.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.