headroom

Name	headroom JSON
Version	0.1.4 JSON
	download
home_page	None
Summary	A powerful, extensible command-line AI assistant.
upload_time	2025-07-08 20:38:25
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

<p align="center">
  <img src="headroom/assets/Max_Logo.png" alt="Max Logo" width="800"/>
</p>

**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/3b/11/d661b640faff8e8c6fe8edf38e7977e899cf6bd2c67d5cbfc35924cd5cf1/headroom-0.1.4.tar.gz",
    "platform": null,
    "description": "# Max Headroom\n\n<p align=\"center\">\n  <img src=\"headroom/assets/Max_Logo.png\" alt=\"Max Logo\" width=\"800\"/>\n</p>\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.1.4",
    "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": "f621f55b0364822516119c3f125fd62a5ea7ed0f37d76fcc285f3aaf37f08b80",
                "md5": "085ec9cda61c22aa298f439925cb18f2",
                "sha256": "fd955d0cb89d8a050ee434e69691c9c21c5a98662e7dafe2cbe1ed98c56c6f2d"
            },
            "downloads": -1,
            "filename": "headroom-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "085ec9cda61c22aa298f439925cb18f2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 2429408,
            "upload_time": "2025-07-08T20:38:23",
            "upload_time_iso_8601": "2025-07-08T20:38:23.562171Z",
            "url": "https://files.pythonhosted.org/packages/f6/21/f55b0364822516119c3f125fd62a5ea7ed0f37d76fcc285f3aaf37f08b80/headroom-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3b11d661b640faff8e8c6fe8edf38e7977e899cf6bd2c67d5cbfc35924cd5cf1",
                "md5": "f8fc32e2b9f3793c0ad149d2d2d1245c",
                "sha256": "8997f01379beaa0e0f092892b826f519d02e99f93c52253903046b8c8224afff"
            },
            "downloads": -1,
            "filename": "headroom-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "f8fc32e2b9f3793c0ad149d2d2d1245c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2430733,
            "upload_time": "2025-07-08T20:38:25",
            "upload_time_iso_8601": "2025-07-08T20:38:25.283238Z",
            "url": "https://files.pythonhosted.org/packages/3b/11/d661b640faff8e8c6fe8edf38e7977e899cf6bd2c67d5cbfc35924cd5cf1/headroom-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 20:38:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SUNKENDREAMS",
    "github_project": "headroom",
    "github_not_found": true,
    "lcname": "headroom"
}