Skip to main content

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 / DeepSeek / Alibaba Cloud (Qwen) / KIMI (Moonshot AI).
  • 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.
  • IoT device support: Control SwitchBot, ECHONET Lite, Matter, and UPnP devices. See IOT_USECASE.md.

IoT Device Support

Control smart home and IoT devices through multiple interfaces:

  • SwitchBot Cloud: List, control, and batch-operate SwitchBot devices (TV, air conditioner, lights, etc.).
    • Infrared remote devices (on/off, brightness, temperature)
    • Air conditioner mode and fan speed control
    • Batch execution of multiple commands
  • SwitchBot BLE: Scan and control nearby SwitchBot BLE devices.
  • ECHONET Lite: Discover and control ECHONET Lite home appliances over the local network.
  • Matter: Inspect Matter controller/bridge/device structure (read-only).
  • UPnP: Discover UPnP devices and manage IGD port forwarding.

For detailed usage, see IOT_USECASE.md.

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. Image analysis via Responses is currently limited to OpenAI / Azure / Bedrock / OpenRouter. For other providers, uag falls back to the provider-specific or chat-completions path.

Developer docs and translations

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.5.6.tar.gz (2.9 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.5.6-py3-none-any.whl (4.1 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for uag-0.5.6.tar.gz
Algorithm Hash digest
SHA256 611f1fb5aa284c6e46579c03d7a33e4d01884b718d4004ab44fe26945facb785
MD5 7f4dac09ed0f0e00ff792297e8a1b740
BLAKE2b-256 7573eea240328b00d51651987f6dd9e0c8428d885df303b758b5792dabaead76

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for uag-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 250449e9d5cc71a3205fd1b649dc1f714076ef42a54d7972f60c6d11d6cf3467
MD5 39676f6ca6fff2fb5785f59c3d020233
BLAKE2b-256 bbbd2ff9c2faae6c07f82d95e6b3dbac1ef6647a09494377aca94812f4b01f89

See more details on using hashes here.

Release history Release notifications | RSS feed

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