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.3.64.tar.gz (1.1 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.3.64-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for uag-0.3.64.tar.gz
Algorithm Hash digest
SHA256 81d26153b2b4b1f9cb6d4b27558b32cf70e59d42a3d4743877aa76cd3a6d8180
MD5 38243f0a2bbc1a05d8abf6944faf2bb6
BLAKE2b-256 cfbcfb960a5c6b3cdb8d45336297e4a6099f4ebe151222f054ebb5156cbb644d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uag-0.3.64-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.3.64-py3-none-any.whl
Algorithm Hash digest
SHA256 b6b1c8ea4e648d706bc091096eed8ff4783b751c7e7d2403a9ed31737a88fa92
MD5 83c4b046b154658d051b277f6bce1d5f
BLAKE2b-256 cc23192e43d35cbe052edfea14b88257c9fb89d01c771b2bf8e9d19c51fded84

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