tsugite-cli 0.3.3__tar.gz

tsugite_cli-0.3.3/.github/copilot-instructions.md

@@ -0,0 +1,258 @@
+## Tsugite: AI Contributor Guide
+
+Tsugite is a micro-agent CLI: agents are Markdown + YAML frontmatter, rendered via Jinja2, and executed by `TsugiteAgent` with a lightweight tool registry.
+
+### Architecture
+
+**Flow:** `Agent.md` (YAML + Jinja2) → `renderer.py` → `TsugiteAgent` → LiteLLM → Tools
+
+**Key Modules:**
+- `cli/__init__.py` - Typer CLI (run, chat, render, config, mcp, tools, agents, attachments, cache, benchmark)
+- `md_agents.py` - Parse frontmatter + agent resolution + directives
+- `builtin_agents/` - File-based built-in agent definitions (default.md, chat-assistant.md)
+- `agent_inheritance.py` - Agent resolution pipeline + inheritance chain
+- `chat.py` - Chat session management with history
+- `ui/textual_chat.py` - Textual TUI for interactive chat
+- `agent_runner.py` - Execution orchestration, prefetch, tool wiring, multi-step
+- `core/agent.py` - LiteLLM agent loop + streaming
+- `renderer.py` - Jinja2 rendering + helpers (now, today, slugify, env, file_exists, read_text, is_file, is_dir)
+- `tools/` - Tool registry + implementations
+- `shell_tool_config.py` + `tools/shell_tools.py` - Custom shell command wrappers
+- `models.py` - Model string parsing + provider dispatch
+- `config.py` - Configuration (default_model, model_aliases, default_base_agent, chat_theme)
+
+**Development:**
+```bash
+uv sync --dev
+uv run pytest tests/test_specific.py -v
+uv run black . && uv run ruff check .
+```
+
+**Agent Resolution Order:**
+1. `.tsugite/{name}.md` - project-local shared
+2. `agents/{name}.md` - project convention
+3. `./{name}.md` - current directory
+4. Package agents directory (`tsugite/builtin_agents/`)
+5. Global agent directories (`~/.config/tsugite/agents/`, etc.)
+
+**Model String:** `provider:model[:variant]` (e.g., `ollama:qwen2.5-coder:7b`, `openai:gpt-4o`)
+
+### Built-in Agents System
+
+File-based agents distributed with the package in `tsugite/builtin_agents/` directory.
+
+**Current Built-ins:**
+1. `default.md` - Base agent with task tracking, spawn_agent, and file tools
+2. `chat-assistant.md` - Chat agent with tools (read_file, write_file, list_files, web_search, fetch_text, run), text_mode enabled
+
+**Location:** `tsugite/builtin_agents/{name}.md`
+
+**Resolution:** Built-in agents are resolved as part of the normal agent resolution order (step 4). Project agents can override them by creating agents with the same name in project directories.
+
+**Adding New Built-ins:**
+1. Create `tsugite/builtin_agents/new_agent.md` with frontmatter and template
+2. Agent is automatically discovered - no code changes needed
+3. Users reference it with `+new_agent` or `new_agent`
+4. Ensure `pyproject.toml` includes builtin_agents directory in package data
+
+### Agent Inheritance
+
+**Chain:** Default base → Extended → Current (highest precedence)
+
+**Merge rules:**
+- Scalars (model, max_steps): Child overwrites
+- Lists (tools): Merge + deduplicate
+- Dicts (mcp_servers): Merge, child keys override
+- Strings (instructions): Concatenate with `\n\n`
+
+**Opt-out:** `extends: none` skips all inheritance.
+
+### Chat Mode
+
+**Components:**
+- `chat.py:ChatManager` - Session management, history (max_history), turn execution
+- `ui/textual_chat.py:ChatApp` - Textual TUI
+- `ui/widgets/` - MessageList, ThoughtLog
+
+**Default Agent:** `chat-assistant`. Override with `.tsugite/chat-assistant.md`.
+
+**Flow:**
+1. User input → `ChatManager.run_turn()`
+2. Inject `chat_history` context (list of ChatTurn objects)
+3. Call `agent_runner.run_agent()` with `force_text_mode=True`
+4. Store result in ChatTurn (timestamp, messages, token_count, cost)
+5. Prune history if `> max_history`
+
+**Text Mode:** `text_mode: true` allows LLM responses without code blocks.
+
+### Directives
+
+**Types:**
+1. `<!-- tsu:ignore -->...<!-- /tsu:ignore -->` - Strip developer docs before LLM
+2. `<!-- tsu:tool name="..." args={...} assign="..." -->` - Execute tool during render
+3. `<!-- tsu:step name="..." assign="..." -->` - Multi-step boundaries
+
+**Parsing:** `md_agents.py:extract_step_directives()`, `extract_tool_directives()`
+
+**Execution:**
+- Ignore blocks: `renderer.py` strips before Jinja2
+- Tool directives: `agent_runner.py:execute_tool_directives()` runs before rendering
+- Step directives: `agent_runner.py:run_multistep_agent()` executes sequentially
+
+**Scoping:**
+- Preamble directives: Execute once, available to all steps
+- Step directives: Execute per step, scoped to that step
+- Variables from previous steps: Always available in later steps
+
+### Development Workflows
+
+**Adding Tools:**
+```python
+# In tools/{category}.py
+from tsugite.tools import tool
+
+@tool
+def my_tool(param: str, optional: int = 10) -> dict:
+    """Brief description.
+
+    Args:
+        param: What it does
+        optional: Optional parameter
+
+    Returns:
+        Result dictionary
+    """
+    if not param:
+        raise ValueError("param required")
+    return {"output": do_work(param, optional)}
+
+# Add to tools/__init__.py:
+# from .category import my_tool  # noqa: F401
+```
+
+**Error conventions:**
+- `ValueError` → bad inputs
+- `RuntimeError` → execution failures
+- Return dict/str; exceptions surfaced as strings to agent
+
+**Safety:** `tools/shell.py` blocks dangerous patterns (`rm -rf /`, `sudo rm`, `dd if=`). Never relax.
+
+**Creating Agents:**
+
+Basic:
+```markdown
+---
+name: my_agent
+model: ollama:qwen2.5-coder:7b
+max_steps: 5
+tools: [read_file, write_file]
+---
+Task: {{ user_prompt }}
+```
+
+Chat:
+```markdown
+---
+name: my_chat
+model: openai:gpt-4o
+text_mode: true
+tools: [read_file, web_search]
+---
+{% if chat_history %}
+{% for turn in chat_history %}
+**User:** {{ turn.user_message }}
+**Assistant:** {{ turn.agent_response }}
+{% endfor %}
+{% endif %}
+{{ user_prompt }}
+```
+
+Multi-step:
+```markdown
+---
+name: researcher
+max_steps: 10
+tools: [web_search, write_file]
+---
+Topic: {{ user_prompt }}
+
+<!-- tsu:step name="research" assign="data" -->
+Research {{ user_prompt }}.
+
+<!-- tsu:step name="summarize" assign="summary" -->
+Summarize: {{ data }}
+
+<!-- tsu:step name="save" -->
+Write {{ summary }} to file.
+```
+
+### Testing
+
+**Commands:**
+```bash
+uv run pytest                              # All tests
+uv run pytest tests/test_file.py::test_x  # Specific test
+uv run pytest --cov=tsugite                # Coverage
+```
+
+**Patterns:**
+```python
+from tsugite.md_agents import parse_agent_file
+from tsugite.agent_inheritance import find_agent_file, get_builtin_agents_path
+from tsugite.chat import ChatManager
+from tsugite.tools import get_tool
+
+# Agent parsing
+agent = parse_agent_file(Path("agent.md"))
+assert agent.config.name == "expected"
+
+# Built-in agents location
+builtin_path = get_builtin_agents_path()
+default_agent = builtin_path / "default.md"
+assert default_agent.exists()
+
+# Resolution
+path = find_agent_file("default", Path.cwd())
+assert path == builtin_path / "default.md"
+
+# Chat
+manager = ChatManager(Path("agent.md"), max_history=10)
+response = manager.run_turn("Hello")
+assert len(manager.conversation_history) == 1
+
+# Tools
+tool = get_tool("read_file")
+assert tool is not None
+```
+
+### Code Standards
+
+**Python 3.12+**, type hints on public APIs
+
+**Style:**
+- Imports: stdlib → third-party → local (blank lines between)
+- Line length: 88 characters (Black)
+- Docstrings: `Args:` / `Returns:` for public functions
+
+**Errors:**
+- `ValueError` → invalid input/config
+- `RuntimeError` → execution failure (include component name)
+
+**Safety:**
+- Shell tool guard: Never relax dangerous patterns blocklist
+- MCP: Requires `--trust-mcp-code` flag
+- File ops: Use `Path.resolve()` to prevent traversal
+
+**Testing:** Test-first workflow. Add minimal failing test, run target, widen to full suite before merge.
+
+### Rendering & Context
+
+**Jinja2:** Undefined variables raise immediately. Use prefetch or tool directives to ensure variables exist.
+
+**Helpers:** `now()`, `today()`, `slugify()`, `file_exists()`, `read_text()`, `is_file()`, `is_dir()`, `env.*`
+
+**Prefetch:** Reduces token use by fetching data before LLM sees prompt. Failures assign `None`—guard with `{% if var %}`.
+
+**Tool Directives:** More flexible than prefetch for multi-step. Scoped per-step, can access step variables.
+
+**Best practice:** Prefetch for initial setup, tool directives for dynamic per-step data.

tsugite_cli-0.3.3/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches: [master, development]
+  pull_request:
+    branches: [master]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run ruff check
+        run: uv run ruff check --show-fixes .
+
+      - name: Run ruff format
+        run: uv run ruff format --check
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run tests
+        run: uv run pytest -v
+
+      - name: Upload coverage reports
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: |
+            coverage.xml
+            htmlcov/
+          retention-days: 30

tsugite_cli-0.3.3/.github/workflows/docker-publish.yml

@@ -0,0 +1,61 @@
+name: Publish Docker Image
+
+on:
+  push:
+    tags:
+      - 'v*'
+  release:
+    types: [published]
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=ref,event=branch
+            type=sha
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile.runtime
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

tsugite_cli-0.3.3/.github/workflows/pypi-publish.yml

@@ -0,0 +1,37 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        # Uses trusted publishing (no API token needed)
+        # For API token method, add with: {password: ${{ secrets.PYPI_API_TOKEN }}}
+        # Package name on PyPI: tsugite-cli
+        uses: pypa/gh-action-pypi-publish@release/v1

tsugite_cli-0.3.3/.gitignore

@@ -0,0 +1,169 @@
+# ---> 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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/
+
+.env
+.env
+benchmark_results/
+test_output/
+.claude/settings.local.json