mlx-code 0.0.8__tar.gz → 0.0.9__tar.gz

mlx_code-0.0.9/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: mlx-code
+Version: 0.0.9
+Summary: Coding Agent for Mac
+Home-page: https://github.com/JosefAlbers/mlx-code
+Author: J Joe
+Author-email: albersj66@gmail.com
+License: Apache-2.0
+Requires-Python: >=3.12.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mlx-lm>=0.31.3; platform_system == "Darwin"
+Requires-Dist: httpx
+Requires-Dist: pydantic
+Requires-Dist: GitPython
+Provides-Extra: all
+Requires-Dist: python-lsp-server[all]; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# mlx-code
+
+A lightweight coding agent built on Apple's MLX framework.
+
+![demo](https://raw.githubusercontent.com/JosefAlbers/mlx-code/main/assets/mlx-code.gif)
+
+---
+
+## Features
+
+- **Composable by design**: `Agent`, `Tool`, and the REPL are separate pieces you can import and wire together however you like
+- **Swappable backends**: point the harness at the local MLX server, a remote provider, or any OpenAI-compatible endpoint without changing anything else
+- **Git worktree isolation**: every session gets a fresh worktree so the agent can't silently corrupt your working tree
+- **9 built-in tools**: `Read`, `Write`, `Edit`, `Bash`, `Grep`, `Find`, `Ls`, `Skill`, `Agent`
+- **Interactive REPL commands**: `/clear`, `/history`, `/tools`, `/branch`, `/abort`
+
+---
+
+## Quick Start
+
+```bash
+pip install mlx-code[all]
+mlxc
+```
+
+---
+
+## Command Line
+
+### `mlxc`: local server + harness
+
+Starts the MLX inference server and launches a harness against it.
+
+```bash
+# Default: local MLX server + built-in REPL harness
+mlxc
+
+# Use a different harness (routes traffic through the local server)
+mlxc --leash claude
+mlxc --leash gemini
+mlxc --leash codex
+
+# Server only, no harness
+mlxc --leash none
+
+# Specify a model
+mlxc --model mlx-community/Qwen3.5-4B-OptiQ-4bit
+
+# Restrict the tools available to the agent
+mlxc --tools Read Write Bash
+
+# Custom system prompt
+mlxc --system "You are a helpful assistant."
+
+# Load skills from a directory (scans recursively for SKILL.md files)
+mlxc --skill ./my-skills
+
+# Resume a previous session from a git commit hash
+mlxc --resume <commit-hash>
+
+# Because `mlxc` reads from stdin when it isn't a TTY, it composes naturally with shell pipes:
+echo "explain lsp.py" | mlxc -d | cat - PLAN.md | mlxc
+```
+
+### `mlxc-run`: harness only
+
+Runs the agent harness against an already-running server or a remote provider.
+
+```bash
+# Connect to a local server at 127.0.0.1:8000 (default)
+mlxc-run
+
+# Remote providers
+mlxc-run --api claude
+mlxc-run --api gemini
+mlxc-run --api deepseek --model deepseek-v4-pro
+mlxc-run --api codex
+
+# Custom endpoint
+mlxc-run --url http://localhost:9000
+
+# With skills
+mlxc-run --skill ./my-skills
+```
+
+---
+
+## Using as a Library
+
+Import the pieces you need to build background workers, scheduled jobs, or event-triggered handlers.
+
+### Spawn an agent from Python
+
+```python
+import asyncio
+from mlx_code.repl import Agent
+
+async def main():
+    agent = Agent(system="You are a concise technical writer.")
+    await agent.run("Summarise all *.py files changed in the last 7 days. Save to digest.md.")
+
+asyncio.run(main())
+```
+
+### Multi-agent pipeline
+
+```python
+import asyncio
+from mlx_code.repl import Agent
+
+async def main():
+    researcher = Agent(system="You are a research assistant.")
+    await researcher.run("Research PBFT consensus. Save a structured summary to kb/draft.md.")
+
+    reviewer = Agent(system="You are a critical reviewer.")
+    await reviewer.run(
+        "Read kb/draft.md. Write a one-paragraph critique to kb/critique.md. "
+        "Use only information in that file."
+    )
+
+asyncio.run(main())
+```
+
+### Parallel workers with `asyncio.gather`
+
+```python
+import asyncio
+from mlx_code.repl import Agent
+
+async def main():
+    topics = ["history", "algorithms", "industry_usage"]
+    agents = [Agent() for _ in topics]
+    await asyncio.gather(*[
+        a.run(f"Research the {t} of Byzantine Fault Tolerance. Save to kb/{t}.md.")
+        for a, t in zip(agents, topics)
+    ])
+    reducer = Agent()
+    await reducer.run("Read all files in kb/. Synthesise into final_report.md.")
+
+asyncio.run(main())
+```
+
+### Resume a session from a git commit
+
+mlx-code stores the full conversation as JSON in each commit message, so you can restore both the workspace state and the agent's memory from any checkpoint.
+
+```python
+import asyncio
+from mlx_code.gits import resume_worktree
+from mlx_code.repl import Agent, repl
+
+async def main():
+    gwt, messages = resume_worktree(".", "abc1234")
+    agent = Agent(ctx={"gwt": gwt})
+    agent.messages = messages
+    await repl(agent)
+
+asyncio.run(main())
+```
+
+### Custom tools
+
+Subclass `Tool`, define a Pydantic schema, and pass the class at instantiation.
+
+```python
+from mlx_code.tools import Tool
+from mlx_code.repl import Agent
+from pydantic import BaseModel, Field
+
+class QueryParams(BaseModel):
+    query: str = Field(description="SQL query to run")
+
+class LiveDBTool(Tool):
+    name = "QueryDB"
+    description = "Execute a query against the dev database"
+    parameters = QueryParams
+
+    async def execute(self, params: QueryParams, signal=None) -> dict:
+        result = run_query(params.query)   # your logic here
+        return {"content": [{"type": "text", "text": result}], "is_error": False}
+
+agent = Agent(extra_tool_classes=[LiveDBTool], tool_names=["QueryDB"])
+```
+
+---
+
+## Credits
+
+Built on [mlx](https://github.com/ml-explore/mlx) and [mlx-lm](https://github.com/ml-explore/mlx-lm). Inspired by Mario Zechner's [pi](https://github.com/badlogic/pi-mono).
+
+## License
+
+Apache License 2.0: see [LICENSE](LICENSE) for details.

mlx_code-0.0.9/README.md

@@ -0,0 +1,193 @@
+# mlx-code
+
+A lightweight coding agent built on Apple's MLX framework.
+
+![demo](https://raw.githubusercontent.com/JosefAlbers/mlx-code/main/assets/mlx-code.gif)
+
+---
+
+## Features
+
+- **Composable by design**: `Agent`, `Tool`, and the REPL are separate pieces you can import and wire together however you like
+- **Swappable backends**: point the harness at the local MLX server, a remote provider, or any OpenAI-compatible endpoint without changing anything else
+- **Git worktree isolation**: every session gets a fresh worktree so the agent can't silently corrupt your working tree
+- **9 built-in tools**: `Read`, `Write`, `Edit`, `Bash`, `Grep`, `Find`, `Ls`, `Skill`, `Agent`
+- **Interactive REPL commands**: `/clear`, `/history`, `/tools`, `/branch`, `/abort`
+
+---
+
+## Quick Start
+
+```bash
+pip install mlx-code[all]
+mlxc
+```
+
+---
+
+## Command Line
+
+### `mlxc`: local server + harness
+
+Starts the MLX inference server and launches a harness against it.
+
+```bash
+# Default: local MLX server + built-in REPL harness
+mlxc
+
+# Use a different harness (routes traffic through the local server)
+mlxc --leash claude
+mlxc --leash gemini
+mlxc --leash codex
+
+# Server only, no harness
+mlxc --leash none
+
+# Specify a model
+mlxc --model mlx-community/Qwen3.5-4B-OptiQ-4bit
+
+# Restrict the tools available to the agent
+mlxc --tools Read Write Bash
+
+# Custom system prompt
+mlxc --system "You are a helpful assistant."
+
+# Load skills from a directory (scans recursively for SKILL.md files)
+mlxc --skill ./my-skills
+
+# Resume a previous session from a git commit hash
+mlxc --resume <commit-hash>
+
+# Because `mlxc` reads from stdin when it isn't a TTY, it composes naturally with shell pipes:
+echo "explain lsp.py" | mlxc -d | cat - PLAN.md | mlxc
+```
+
+### `mlxc-run`: harness only
+
+Runs the agent harness against an already-running server or a remote provider.
+
+```bash
+# Connect to a local server at 127.0.0.1:8000 (default)
+mlxc-run
+
+# Remote providers
+mlxc-run --api claude
+mlxc-run --api gemini
+mlxc-run --api deepseek --model deepseek-v4-pro
+mlxc-run --api codex
+
+# Custom endpoint
+mlxc-run --url http://localhost:9000
+
+# With skills
+mlxc-run --skill ./my-skills
+```
+
+---
+
+## Using as a Library
+
+Import the pieces you need to build background workers, scheduled jobs, or event-triggered handlers.
+
+### Spawn an agent from Python
+
+```python
+import asyncio
+from mlx_code.repl import Agent
+
+async def main():
+    agent = Agent(system="You are a concise technical writer.")
+    await agent.run("Summarise all *.py files changed in the last 7 days. Save to digest.md.")
+
+asyncio.run(main())
+```
+
+### Multi-agent pipeline
+
+```python
+import asyncio
+from mlx_code.repl import Agent
+
+async def main():
+    researcher = Agent(system="You are a research assistant.")
+    await researcher.run("Research PBFT consensus. Save a structured summary to kb/draft.md.")
+
+    reviewer = Agent(system="You are a critical reviewer.")
+    await reviewer.run(
+        "Read kb/draft.md. Write a one-paragraph critique to kb/critique.md. "
+        "Use only information in that file."
+    )
+
+asyncio.run(main())
+```
+
+### Parallel workers with `asyncio.gather`
+
+```python
+import asyncio
+from mlx_code.repl import Agent
+
+async def main():
+    topics = ["history", "algorithms", "industry_usage"]
+    agents = [Agent() for _ in topics]
+    await asyncio.gather(*[
+        a.run(f"Research the {t} of Byzantine Fault Tolerance. Save to kb/{t}.md.")
+        for a, t in zip(agents, topics)
+    ])
+    reducer = Agent()
+    await reducer.run("Read all files in kb/. Synthesise into final_report.md.")
+
+asyncio.run(main())
+```
+
+### Resume a session from a git commit
+
+mlx-code stores the full conversation as JSON in each commit message, so you can restore both the workspace state and the agent's memory from any checkpoint.
+
+```python
+import asyncio
+from mlx_code.gits import resume_worktree
+from mlx_code.repl import Agent, repl
+
+async def main():
+    gwt, messages = resume_worktree(".", "abc1234")
+    agent = Agent(ctx={"gwt": gwt})
+    agent.messages = messages
+    await repl(agent)
+
+asyncio.run(main())
+```
+
+### Custom tools
+
+Subclass `Tool`, define a Pydantic schema, and pass the class at instantiation.
+
+```python
+from mlx_code.tools import Tool
+from mlx_code.repl import Agent
+from pydantic import BaseModel, Field
+
+class QueryParams(BaseModel):
+    query: str = Field(description="SQL query to run")
+
+class LiveDBTool(Tool):
+    name = "QueryDB"
+    description = "Execute a query against the dev database"
+    parameters = QueryParams
+
+    async def execute(self, params: QueryParams, signal=None) -> dict:
+        result = run_query(params.query)   # your logic here
+        return {"content": [{"type": "text", "text": result}], "is_error": False}
+
+agent = Agent(extra_tool_classes=[LiveDBTool], tool_names=["QueryDB"])
+```
+
+---
+
+## Credits
+
+Built on [mlx](https://github.com/ml-explore/mlx) and [mlx-lm](https://github.com/ml-explore/mlx-lm). Inspired by Mario Zechner's [pi](https://github.com/badlogic/pi-mono).
+
+## License
+
+Apache License 2.0: see [LICENSE](LICENSE) for details.