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 / Claude / Grok / NVIDIA.
  • Flexible Interfaces:
    • CLI: uag / python -m uagent
    • GUI: uagg / python -m uagent.gui
    • Web: uagw / python -m uagent.web
  • 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

You can launch an A2A-compatible HTTP server separate from the existing interfaces.

uaga
# or python -m uagent.a2a.server

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.61.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.3.61-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uag-0.3.61.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.3.61.tar.gz
Algorithm Hash digest
SHA256 577cd2c2711e75aca206f824d40f82e4ee9f6b765371f1f6b21d201e97a44c51
MD5 3a2feaf2262d1a4842ff13722de75ba1
BLAKE2b-256 a6b0a0dc236d8e697217dc27c3238ac65a4c8aa2a15e30e2766835bceafe8a9e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uag-0.3.61-py3-none-any.whl
  • Upload date:
  • Size: 1.4 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.61-py3-none-any.whl
Algorithm Hash digest
SHA256 8cf02d9c6f26e127440d4d351334e701d65de406e8cd58ec7a409b25405583ef
MD5 1ce7daa01bab0c6c02a8d9b6f2cd274f
BLAKE2b-256 bb4ec20dac1364dd1acd98f19cc6e3defe8c14eb7cc6dccefba73f848b359d9a

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