aicheat 0.4.0.post1__tar.gz

aicheat-0.4.0.post1/.gitignore

@@ -0,0 +1,178 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+
+src/aicheat/_version.py

aicheat-0.4.0.post1/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+        args: ["--assume-in-merge"]
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: sort-simple-yaml
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.11.8"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        additional_dependencies: ["tomli"]
+  - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+    rev: v2.14.0
+    hooks:
+      - id: pretty-format-toml
+        args: [--autofix, --no-sort]
+      - id: pretty-format-yaml
+        args: [--autofix, --indent, "2", "--offset", "2", --preserve-quotes]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args: [--py38-plus]

aicheat-0.4.0.post1/AGENTS.md

@@ -0,0 +1,58 @@
+# aicheat
+
+`aicheat` is a python cli-based coding assistant.
+
+## Features
+
+- Uses `prompt-toolkit` for input, leveraging its powerful line-editing capabilities
+- Theming support using `pygments`
+- Live streaming of model output using `rich.live.Live`
+- Tool calling capabilities
+- `AGENTS.md`/`CLAUDE.md` file support
+- Skills support
+
+## Installation
+
+The package can be installed in editable mode.
+
+```bash
+uv pip install -e '.[dev]'
+```
+
+This will install the `aicheat` entrypoint script and make changes immediately available after modifying the code.
+
+## Development
+
+- New commands can be defined as functions in the `aicheat.commands` module, these should be registered using the `aicheat.commands.command_handler` decorator
+- New tools can be defined as submodules in the `aicheat.tools` module. New tools:
+  - Have to be registered using the `aicheat.tools.core.tool` decorator, which registers tools in the registry (`aicheat.tools.registry`)
+  - Registered (and enabled) tools are made available to the model on every call
+  - `aicheat.tools.get_tools` can be used to retrieve enabled tools
+  - Tools can be enabled enabled/disabled at runtime by users by setting the `enabled` attribute
+  - Tools/tools modules are automatically loaded from `aicheat.tools` submodules, the mechanism used to accomplish this is `aicheat.utils._init_submodules`, which needs to be invoked in every module's, see `aicheat.code`'s `__init__.py` for an example.
+
+## Tests
+
+A minimal set of tests is defined in the `tests` directory. These use `pytest` and can be run like so:
+
+```bash
+pytest tests
+# Select tests using: -k
+pytest tests -k test_skills # runs all the skills tests
+pytest tests/test_skills.py # run the full skills test module
+```
+
+New features should implement unit tests and integrations tests, when possible.
+
+## Release Process
+
+To create release notes for a new version:
+
+1. Check what commits have been added since the last release using the `git_updates` tool
+2. Examine specific commits with `git show COMMIT_HASH` to understand the changes
+3. Review previous release notes format by checking the annotated tag with `git show LAST_VERSION`
+4. Create release notes following the established format (New, Fixes, Misc sections as appropriate)
+5. Save the release notes in a file named after the version (e.g., `v0.2.3.md`)
+6. Create a new annotated tag with `git tag -a v0.2.3 -m "$(cat v0.2.3.md)"`
+
+This process ensures consistent documentation of changes and follows the project's established conventions.

aicheat-0.4.0.post1/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: aicheat
+Version: 0.4.0.post1
+Summary: A CLI programming assistant for computer-science tasks
+Author-email: brethil <bretello@distruzione.org>
+License: GPLv3
+Keywords: ai,cli,coding-assistant,llm,developer-tools
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: openai>=2.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: prompt_toolkit>=3.0.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pygments>=2.16.0
+Requires-Dist: tomlkit>=0.14.0
+Requires-Dist: pygit2>=1.19.1
+Requires-Dist: pyyaml>=6
+Provides-Extra: dev
+Requires-Dist: ruff>=0.15.4; extra == "dev"
+Requires-Dist: typing-extensions>=4.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+
+# aicheat
+
+A command-line based AI coding assistant
+
+[![demo](aicheat-demo.mp4)](https://asciinema.org/a/1vcAJJKvLWtSu6Ni)
+
+## Features
+
+- Supports OpenAI-compatible inference servers (such as vLLM/llama.cpp/OpenAI, ...)
+- Powerful line editing/completion capabilities thanks to [`prompt-toolkit`](https://github.com/prompt-toolkit/python-prompt-toolkit)
+- Theming support using `pygments`
+- Extensibility via custom tool definitions
+- Skills support
+
+## Installation
+
+```bash
+# Install a stable version
+uv pip install git+https://git.decapod.one/brethil/aicheat@v0.4.0
+
+# Install the latest main
+uv pip install git+https://git.decapod.one/brethil/aicheat@main
+
+# Install the latest dev
+uv pip install git+https://git.decapod.one/brethil/aicheat@dev
+
+# Clone and install (development)
+git clone https://git.decapod.one/brethil/aicheat
+uv pip install -e ".[dev]"
+```
+
+## Quick Start
+
+- `AICHEAT_HOST`: path to an OpenAI-compatible server, such as [vllm](https://github.com/vllm-project/vllm), or [llama.cpp](https://github.com/ggerganov/llama.cpp), see instructions in [docs](docs/)
+- `OPENAI_API_KEY`: (optional) set if API Key is required to connect to `AICHEAT_HOST`
+- `AICHEAT_MODEL`: (optional) set default model. If a single model is available on `AICHEAT_HOST`, it is automatically selected. If multiple models are available, user is prompted to select the model.
+
+Note: this should also work with the official OpenAI API, although this is untested.
+
+Start chatting:
+
+```bash
+aicheat
+
+# Optionally, a starting message can be provided:
+aicheat "What's the current status of this git repo?"
+
+# optional: select a model
+export AICHEAT_MODEL="your-model-name"
+```
+
+In the `aicheat` "REPL":
+
+- Type `/help` for available commands
+- Type `/tools` to see available tools
+- Use `/theme list` to list/select available themes, using `/config save` to persist the theme choice.
+- Prefix messages with `!` to run a shell command, e.g. `!uptime` calls `uptime`.
+- Type a question to start chatting
+
+## Provider Documentation
+
+See [docs/providers/](docs/providers/) for detailed instructions on using aicheat with different OpenAI-compatible API providers:
+
+- [OpenAI API](docs/providers/openai.md)
+- [vLLM](docs/providers/vllm.md)
+- [llama.cpp](docs/providers/llamacpp.md)
+- [Local providers (Ollama, LM Studio, etc.)](docs/providers/local.md)
+
+## Usage Examples
+
+### Basic Usage
+
+```bash
+# Start a chat session
+aicheat
+
+# Start with an initial prompt
+aicheat "What's the status of this git repo?"
+
+aicheat
+```
+
+### In-Chat Commands
+
+Once in the chat, you can use these commands:
+
+- `/help` - List available commands
+- `/tools` - List available tools
+- `/clear` - Clear the conversation history (or hit ctrl-c twice)
+- `/multiline` - Toggle multiline input mode, also see Editor/Multiline section below
+- `/model` - Show/set the active model
+- `/fragment <file> [prompt]` - Include a file in the session with optional instructions
+
+## Tool Calling
+
+aicheat comes with several built-in tools
+
+### File Operations
+
+- `read_file(filename)` - Read the content of a file
+- `write_file(filename, content)` - Write content to a file
+- `apply_patch(filename, content)` - Patch a file
+- `search(pattern, path)` - Search for patterns in files using ripgrep
+
+### System & Shell
+
+- `execute_shell_command(cmd)` - Execute shell commands (with confirmation)
+- `man(program_name)` - Retrieve man pages for programs
+- `pwd()` - Get current working directory
+- `cd(path)` - Change directory
+
+### Git Integration
+
+- `git_status()` - Show git status as a diff
+- `git_updates(from_refish)` - Show commits since last tag/release
+- `git_show_patch(commit_id)` - Show patch for a specific commit
+- `git_list_files()` - List all git-tracked files
+
+### Code Execution
+
+- `execute_python_code(code)` - Execute Python code snippets (with confirmation)
+
+### Web & Documentation
+
+- `cheat_sh_search(program_name)` - Search cheat.sh for program documentation
+
+## Adding Custom Tools
+
+You can extend aicheat with custom tools by creating new modules in `src/aicheat/tools/`.
+
+Here's an example for a `ping` tool to check network status:
+
+```python
+from aicheat.tools.core import tool
+from subprocess import check_output, CalledProcessError, STDOUT
+import re
+
+
+@tool(
+    message_template="🌐 Pinging {host} {count} times}"
+    requires_confirmation=False,
+)
+def ping(host: str, count: int) -> str:
+    """Pings a host using the unix `ping` tool"""
+    if not host:
+        return "No host provided"
+
+    try:
+        result = check_output(
+            ["ping", "-c", str(count), host],
+            text=True,
+            stderr=STDOUT,  # redirect stderr to stdout
+        )
+    except CalledProcessError as exc:
+        result = f"ping failed with returncode={exc.returncode}\noutput:\n{exc.stdout}"
+
+    return result
+```
+
+Note: `@tool()` must always be called with parentheses.
+
+For more examples, see:
+
+- `aicheat.tools.shell` - Shell-related tools
+- `aicheat.tools.git` - Git-related tools
+- `aicheat.tools.code.python` - Python-related code tools
+
+## Tips & Tricks
+
+### Shell Integration
+
+Add an alias to `aicheat` so that it's prefixed by noglob, making it easier to give initial prompts from the shell without expanding globs:
+
+```bash
+echo "alias aicheat=\"noglob aicheat\"" >> ~/.zshrc
+```
+
+### Editor/Multiline
+
+The REPL uses `prompt-toolkit` to leverage its powerful line-editing capabilities. `aicheat`, depending on your `$EDITOR` value supports:
+
+- emacs-style line-editing shortcuts:
+  - use `ctrl-x ctrl-e` to open the current line in your `$EDITOR`)
+  - ctrl-a/ctrl-e to move to beginning/end of the current line and other emacs-style movements
+- vi-style line-editing shortcuts:
+  - `vv` to open the current line in your `$EDITOR`
+  - modal editing and other vi-style movement shortcuts
+
+Multiline editing is also supported, either via `/multiline` or via `ctrl-v`. This can be useful to paste text/code.
+
+## Requirements
+
+- Python 3.8+
+- An OpenAI-compatible API server (like vLLM or llama.cpp)
+- [`ripgrep`](https://github.com/BurntSushi/ripgrep) (optional, for improved search functionality)
+- `cht.sh` CLI tool (optional, for [cheat.sh](https://cheat.sh) functionality)
+
+## License
+
+# MIT
+
+- `aicheat.tools.shell` shell-related tools
+- `aicheat.tools.git` git-related tools
+- `aicheat.tools.code.python` python-related code tools
+
+## Skills
+
+Load skills using `/skill load path/to/skill`