Skip to main content

A powerful tool execution agent

Project description

uag logo

uag (Local AI Agent)

uag is a local interactive agent that executes commands, manipulates files, and reads data files such as PDF, PPTX, and Excel. It provides three user interfaces: CLI, GUI, and Web. uag is built to keep you free from vendor-locked apps: use the interface that fits your workflow, switch providers, and stay in control of your environment. GitHub: https://github.com/awaku7/agentcli

Installation

Install from PyPI with pip:

pip install uag

If you use a virtual environment, activate it first and then run the command above.

On first launch, uag checks your environment and starts the setup wizard automatically when required provider variables are missing. For configuration details, see ENVIRONMENT.md.

Key Features

  • Practical toolset: File manipulation, web search, PDF/PPTX/Excel extraction, image generation, and image analysis.
  • Multi-provider support: OpenAI / Azure / Bedrock / OpenRouter / Ollama / Gemini / Vertex AI / Claude / Grok / NVIDIA.
  • Three 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 support: Connect to external MCP tool servers.
  • Session continuity: Keep context when switching models or providers.
  • Web Inspector: Save browser transitions, DOM snapshots, and screenshots with playwright_inspector.
  • Built-in docs: Read bundled docs with uag docs.

Usage

Start and exit

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

A2A server

Launch an Agent2Agent-compatible HTTP server:

uaga

See ENVIRONMENT.md for UAGENT_A2A_* settings such as auth, host, port, reload, public base URL, concurrency, and engine.

Handy tips

  • :tools: show loaded tools
  • :logs [n]: show recent session logs
  • :load <index>: load a previous session
  • :skills: select and load Agent Skills
  • :shrink [n]: summarize history and keep the last n messages

Configuration and details

Environment variables and setup

For API keys, language settings (UAGENT_LANG), history shrink settings, and more, see ENVIRONMENT.md.

  • Setup wizard: python -m uagent.setup_cli
  • Encrypted environment: use uag_envsec to encrypt .env as .env.sec
  • Update encrypted values: uag_envsec add --file .env.sec --key NAME --value VALUE

Responses API note

If you set UAGENT_RESPONSES=1, Responses API is used for supported providers: OpenAI / Azure / Bedrock / OpenRouter / Ollama. Gemini / Claude / Vertex AI use their native API paths and are not covered by Responses API. For other providers, uag falls back to the provider-specific or chat-completions path.

Developer docs and translations

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.17.tar.gz (1.8 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.17-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for uag-0.4.17.tar.gz
Algorithm Hash digest
SHA256 a5696c8f075e0a437bc37a67ff1448ea8f9eac2ab93efd1c8cf5858730c1c03c
MD5 34f00990790c65832df99cedf00c68e2
BLAKE2b-256 1f5012f085d9a80ef17a175df6c85b0f38d0f1dde62e34de39af2bb9cfb27268

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for uag-0.4.17-py3-none-any.whl
Algorithm Hash digest
SHA256 9760fc48cab61246aa197b0f0e4d0d42a03be1d6cf659c9f882f724a7d3e0b0a
MD5 0859ca131b4838c71b564e2b64b8b57c
BLAKE2b-256 8a941732db48a34790cbc4ec6a3abd255459ee929f820f2fe6d6cc409b52620d

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