| Name | headroom JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A powerful, extensible command-line AI assistant. |
| upload_time | 2025-07-09 17:50:40 |
| maintainer | None |
| docs_url | None |
| author | James Bridges |
| requires_python | None |
| 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.
|
| keywords |
ai
agent
cli
llm
automation
tools
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```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)
---
Raw data
{
"_id": null,
"home_page": null,
"name": "headroom",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ai, agent, cli, llm, automation, tools",
"author": "James Bridges",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1d/61/d49be139e4db80fb6b06007441a0c9ddf8fee035e4a89b966779a25774df/headroom-0.2.0.tar.gz",
"platform": null,
"description": "# Max Headroom\n\n\n\n**Max> A Command-line AI Agent**\n\n---\n\n## Overview\n\n**Max** is a powerful, extensible command-line AI assistant. It can:\n- Connect to local or cloud based LLMs\n- Interpret natural language commands\n- Run system tools and shell commands safely (with confirmation)\n- Manage files, directories, packages, and more\n- Provide interactive chat and planning features\n\n---\n\n## Installation\n\n```sh\npip install headroom\n```\n\n---\n\n## Usage\n\nStart Max from your terminal:\n\n```sh\nmax\n```\n\nType natural language requests or commands, for example:\n- `create a new directory called test`\n- `copy file.txt to backup/`\n- `install package requests`\n- `help`\n- `exit`\n\nMax will confirm actions before running anything that changes your system and remeber your preferences.\n\n---\n\n## Features\n\n- **Natural Language Understanding:** Ask for actions in plain English.\n- **Safe Execution:** Confirmation prompts for system changes.\n- **Always Allow/Revocation:** Mark commands as always allowed or revoke them.\n- **Tab Completion:** Quickly find available commands.\n- **Extensible:** Add your own tools and commands.\n\n---\n\n## Configuration & Customization\n\n- **Config:** Edit `config.yaml` to customize commands and behavior.\n- **User Preferences:** Preferences are stored and managed automatically.\n\n---\n\n## Development\n\nClone the repo and install dependencies:\n\n```sh\ngit clone https://github.com/SUNKENDREAMS/headroom.git\ncd headroom\npip install -e .\n```\n\nRun locally:\n\n```sh\npython -m headroom.max\n```\n\n---\n\n## License\n\nMIT License. See [LICENSE](LICENSE) for details.\n\n---\n\n## Author\n\nJames Bridges\n\n---\n\n## Contributing\n\nPull requests and issues are welcome!\n\n---\n\n## Acknowledgements\n\n- [prompt_toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit)\n- [pyyaml](https://github.com/yaml/pyyaml)\n- [requests](https://github.com/psf/requests)\n- [python-dotenv](https://github.com/theskumar/python-dotenv)\n\n---\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 James Bridges\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A powerful, extensible command-line AI assistant.",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/SUNKENDREAMS/headroom/issues",
"Homepage": "https://github.com/SUNKENDREAMS/headroom"
},
"split_keywords": [
"ai",
" agent",
" cli",
" llm",
" automation",
" tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5a7889a72eb7c947b6edb1486636eb56eb3a7063372a6b4a35a28ef19f42be94",
"md5": "2ccdaeb9b962bdb62447bd61d0ee50cf",
"sha256": "d129f5fe4857b9d692c24a5cfe358a5543b987ea4e459395bc36ad9b8a7e7817"
},
"downloads": -1,
"filename": "headroom-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ccdaeb9b962bdb62447bd61d0ee50cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5293686,
"upload_time": "2025-07-09T17:50:38",
"upload_time_iso_8601": "2025-07-09T17:50:38.627694Z",
"url": "https://files.pythonhosted.org/packages/5a/78/89a72eb7c947b6edb1486636eb56eb3a7063372a6b4a35a28ef19f42be94/headroom-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1d61d49be139e4db80fb6b06007441a0c9ddf8fee035e4a89b966779a25774df",
"md5": "9e9f5f238fc81b298c1c1c1ee8b1f3aa",
"sha256": "e26ee2bebf38ec1a93ec64a82a2480862bfd2cd152153c1511304ad331015465"
},
"downloads": -1,
"filename": "headroom-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "9e9f5f238fc81b298c1c1c1ee8b1f3aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5294472,
"upload_time": "2025-07-09T17:50:40",
"upload_time_iso_8601": "2025-07-09T17:50:40.237162Z",
"url": "https://files.pythonhosted.org/packages/1d/61/d49be139e4db80fb6b06007441a0c9ddf8fee035e4a89b966779a25774df/headroom-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 17:50:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SUNKENDREAMS",
"github_project": "headroom",
"github_not_found": true,
"lcname": "headroom"
}
