Skip to main content

A powerful tool execution agent

Project description

██╗   ██╗ █████╗  ██████╗ ███████╗███╗   ██╗████████╗ ██████╗██╗     ██╗
██║   ██║██╔══██╗██╔════╝ ██╔════╝████╗  ██║╚══██╔══╝██╔════╝██║     ██║
██║   ██║███████║██║  ███╗█████╗  ██╔██╗ ██║   ██║   ██║     ██║     ██║
██║   ██║██╔══██║██║   ██║██╔══╝  ██║╚██╗██║   ██║   ██║     ██║     ██║
╚██████╔╝██║  ██║╚██████╔╝███████╗██║ ╚████║   ██║   ╚██████╗███████╗██║
 ╚═════╝ ╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═══╝   ╚═╝    ╚═════╝╚══════╝╚═╝

uag (Local AI Agent)

uag is an interactive agent that executes commands, manipulates files, and reads various data formats (PDF/PPTX/Excel, etc.) on your local PC. It provides three interfaces: CLI, GUI, and Web.

Installation

You can install uag via pip:

pip install uag

After installation, running uag for the first time will automatically launch an interactive setup wizard to configure your environment variables. For detailed information on configuration and encryption, see ENVIRONMENT.md.

Key Features

  • Practical Toolset: Equipped with tools for file manipulation, web search, data extraction (PDF/PPTX/Excel), image generation, and analysis, all executable in your local environment.
  • Multi-Provider Support: Supports OpenAI / Azure / Bedrock / OpenRouter / Ollama / Gemini / Vertex AI / Claude / Grok / NVIDIA.
  • Flexible Interfaces:
    • CLI: uag / python -m uagent
    • GUI: uagg / python -m uagent.gui
    • Web: uagw / python -m uagent.web
    • A2A (Server): uaga / python -m uagent.a2a.server
  • MCP (Model Context Protocol): Support for connecting to external MCP tool servers.
  • Session Continuity: Maintain conversation context even when switching providers or models.
  • Web Inspector: Automatically save browser transitions, DOM, and screenshots using playwright_inspector.
  • Built-in Docs: Instantly access detailed internal documentation using the uag docs command.

Usage

Start and Exit

Run uag from your terminal to start. Type :exit to quit.

A2A (Agent2Agent) Server

Launch an A2A-compatible HTTP server:

uaga

Handy Tips (Continuity and Control)

  • :tools: Display a list of loaded tools.
  • :logs [n]: Show session logs (n to specify the number of entries).
  • :load <index>: Load a past session to resume the conversation.
  • :skills: Select and load Agent Skills (additional roles or instructions).
  • :shrink [n]: Organize history to keep only the last n messages to save tokens.

Configuration and Details

Environment Variables and Setup

For detailed settings (API keys, display language UAGENT_LANG, history shrink settings, etc.), see ENVIRONMENT.md.

  • Setup: Configure interactively via python -m uagent.setup_cli.
  • Encryption: Securely encrypt your .env file using the uag_envsec tool.

Developers and Internationalization

Project details


Download files

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

Source Distribution

uag-0.4.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

uag-0.4.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file uag-0.4.0.tar.gz.

File metadata

  • Download URL: uag-0.4.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for uag-0.4.0.tar.gz
Algorithm Hash digest
SHA256 37e4db46ef9483b0bcb5f4f75186ddb36dae11f15e93f9cccac85862c8d10716
MD5 6713f21362942bae7d01c06eb678dd9c
BLAKE2b-256 110fdf61db3eef9f4401ef3c2e70aaa814a63a55c4ae1fe08410c9176099a4e7

See more details on using hashes here.

File details

Details for the file uag-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: uag-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for uag-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2207f6ee918e34a436481282c3308bba0c4c78f4a818ccbe44f075d6259abd1
MD5 f121a95be299b325699f044863f6e4f8
BLAKE2b-256 d1bb94ca4b84eb084e53bb4a6702eb5f34d78fb3b931b6b20bac181e0a1ab537

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