Skip to main content

Experimental Python-runner coding agent with a Textual TUI

Project description

uv-agent

简体中文

uv-agent is a portable coding agent with a Textual TUI. Its only external action surface is run_python: the model submits Python scripts to a managed uv run runner, and those scripts do the actual work. This single-tool design keeps agent behavior consistent across platforms—any OS with Python and uv behaves the same way.

Public APIs, config fields, and runtime behavior may still change as the project evolves.

Install And Run

Prerequisites
You need uv and ripgrep installed on your system. uv is the Python package and project manager used to run the agent; ripgrep is used for fast file-content searches inside the workspace.

Run the latest published package:

uvx uv-agent@latest

Run from a local checkout:

uv run uv-agent

Ask a single prompt without opening the TUI:

uvx uv-agent@latest ask "Reply with exactly: ok"

Resume an existing thread:

uvx uv-agent@latest ask --thread thr_xxx "Continue from here"

Configuration

User config lives at ~/.uv-agent/config.json. A project can override it with .uv-agent/config.json; that project-local directory is ignored by git. Keep API keys in environment variables or ignored local config.

API compatibility
This project supports three API formats — set api on your model config:

api value Format Status
"chat_completions" OpenAI Chat Completions API ✅ Primary (fully supported)
"responses" OpenAI Responses API ⚠️ Experimental — may have bugs
"anthropic_messages" Anthropic Messages API ⚠️ Experimental — may have bugs

Issues and PRs are welcome for any format!Example configuration:

{
  "providers": {
    "deepseek": {
      "base_url": "https://api.deepseek.com",
      "api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "chat_completions": {
        "path": "/chat/completions"
      },
      "message_passthrough": {
        "assistant": [
          "reasoning_content"
        ]
      },
      "reasoning_display": {
        "assistant_message_fields": [
          "reasoning_content"
        ],
        "stream_delta_fields": [
          "reasoning_content"
        ]
      }
    }
  },
  "models": {
    "deepseek-v4-flash": {
      "provider": "deepseek",
      "model": "deepseek-v4-flash",
      "api": "chat_completions",
      "supports_images": false,
      "context_window_tokens": 1000000,
      "params": {
        "reasoning_effort": "high"
      }
    },
    "deepseek-v4-pro": {
      "provider": "deepseek",
      "model": "deepseek-v4-pro",
      "api": "chat_completions",
      "supports_images": false,
      "context_window_tokens": 1000000,
      "params": {
        "reasoning_effort": "max"
      }
    }
  },
  "levels": {
    "deepseek-flash": {
      "model": "deepseek-v4-flash"
    },
    "deepseek-pro": {
      "model": "deepseek-v4-pro"
    }
  },
  "runtime": {
    "default_level": "deepseek-flash",
    "store_provider_response": false,
    "max_agent_rounds": 1000,
    "compression": {
      "enabled": true,
      "model_level": "deepseek-flash",
      "trigger_ratio": 0.9
    },
    "title_generation": {
      "enabled": true,
      "model_level": "deepseek-flash"
    }
  },
  "runner": {
    "default_timeout_s": 7200,
    "max_output_bytes": 1000000
  },
  "ui": {
    "completion_notification": {
      "enabled": true
    }
  }
}

Use /config in the TUI to switch the default level, language, and automatic compression. Set ui.language to zh-CN for a Chinese UI. Completion notifications can be configured under ui.completion_notification. Non-Windows platforms use the terminal bell for completion sound.

See configuration for all supported options and config.example.json for a detailed example.

Documentation

Core Ideas

  • The agent has exactly one external action surface: run_python.
  • Managed scripts declare third-party dependencies with PEP 723 inline metadata.
  • The distributed package includes both uv_agent and uv_agent_runtime; managed scripts import helpers from uv_agent_runtime.
  • Workspace rules, skills, and MCP declarations are progressively disclosed as context. MCP calls happen from Python runtime helpers, not direct model tools.
  • Thread state, run logs, saved scripts, and attachments live under ~/.uv-agent/projects/<project-id>/.

Development

uv run pytest

Local debug state, screenshots, config, scripts, runs, and thread data belong in .uv-agent/ and should stay out of git.

License

MIT. See LICENSE.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uv_agent-0.5.2.tar.gz (367.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uv_agent-0.5.2-py3-none-any.whl (149.8 kB view details)

Uploaded Python 3

File details

Details for the file uv_agent-0.5.2.tar.gz.

File metadata

  • Download URL: uv_agent-0.5.2.tar.gz
  • Upload date:
  • Size: 367.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for uv_agent-0.5.2.tar.gz
Algorithm Hash digest
SHA256 1234c8ac027f6e8fa00688e0683d654c25d657885a029f0b5ff283f53208d7bc
MD5 01a120d5b21de4a3fed26a437760f8e2
BLAKE2b-256 00ad2acd5ce80b67839713e254cdaaa64fe1945f85330c59bb7841a835d57f0e

See more details on using hashes here.

File details

Details for the file uv_agent-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: uv_agent-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 149.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for uv_agent-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 990084a49086b1119e5f64a2b7ebf950388fee78ed7e11a2004981832233a9d8
MD5 b84561f0c5719d9f03eb8b89e044cc02
BLAKE2b-256 7e5a13100f57615e3d1ca50860f3123b3eb484b4a6abe985a05676aa85e9f161

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page