Skip to main content

The Watcher - An agentic system troubleshooting tool powered by Claude

Project description

Uatu

Your AI partner for system operations and troubleshooting.

autu-demo

Core capabilities:

  • Interactive chat: Conversational troubleshooting with your system
  • Stdin mode: Pipe logs and data for instant AI analysis
  • Security-first: Granular command approval and allowlist system
  • Intelligent analysis: Connect CPU spikes, memory leaks, and process behavior

Tested on Platforms:

  • macOS
  • Linux

Installation

Using pipx (recommended)

# Install with pipx for isolated environment
pipx install uatu

# Configure API key
echo "ANTHROPIC_API_KEY=your_key" > .env

Using pip

# Install globally or in a virtual environment
pip install uatu

# Configure API key
echo "ANTHROPIC_API_KEY=your_key" > .env

From source with uv

# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and install
git clone https://github.com/fractalops/uatu.git
cd uatu
uv sync

# Configure API key
echo "ANTHROPIC_API_KEY=your_key" > .env

Quick Start

Interactive Chat Mode (Default)

Start a conversational troubleshooting session:

# Default mode
uatu

# Allow bash commands with approval prompts
UATU_READ_ONLY=false uatu

Ask questions naturally and get AI-powered system analysis:

  • "What's causing high CPU usage?"
  • "Why is my server running slowly?"
  • "Investigate recent memory issues"
  • "What's listening on port 8080?"

Security: Bash commands require user approval. Use UATU_READ_ONLY=true for read-only mode (MCP tools only).

Stdin Mode (One-Shot Analysis)

Pipe system data directly for instant troubleshooting:

# Enable bash + auto-use allowlist for stdin mode
UATU_READ_ONLY=false cat /var/log/app.log | uatu "find errors and suggest fixes"

# Investigate crashed process (Linux)
UATU_READ_ONLY=false journalctl -u myservice --since "1 hour ago" | uatu "why did this crash?"

# Debug high memory usage
UATU_READ_ONLY=false ps aux | head -20 | uatu "diagnose memory issues"

Safe mode (default) - MCP tools only, no bash:

# Analyze with MCP tools only (safest)
cat /var/log/syslog | uatu "check for issues"

With bash commands:

# Auto-approves commands in SAFE_BASE_COMMANDS (df, ps, top, etc.)
UATU_READ_ONLY=false dmesg | uatu "check hardware errors"

Note: In stdin mode, approval auto-detects - allowlisted commands are auto-approved without prompts.

Configuration

Create .env with options:

# Required
ANTHROPIC_API_KEY=your_key

# Optional
UATU_MODEL=claude-sonnet-4-5-20250929  # Claude model to use
UATU_READ_ONLY=true                     # Agent can only read, not modify system
UATU_REQUIRE_APPROVAL=true              # Require approval for risky actions
UATU_ALLOW_NETWORK=false                # Block network commands (curl, wget, etc.)

Security Features

Command Approval System

All bash commands require approval unless allowlisted:

 Bash command approval required
Risk: Credential Access

⚠ Warning: This command may access SSH keys, certificates, or other credentials

ls -la ~/.ssh/

   Allow once
   Always allow (exact)
   Deny

Audit Logging

All security decisions are logged:

# View audit log (last 100 events)
uatu audit

# View recent events
uatu audit --last 20

# View specific event types
uatu audit --type bash_command_approval

# View summary statistics
uatu audit --summary

Allowlist Management

View and manage approved commands:

# View allowlist
cat ~/.config/uatu/allowlist.json

# Interactive chat commands (with tab completion)
/allowlist                              # Show approved commands
/allowlist add <command>                # Add command to allowlist
/allowlist remove <pattern>             # Remove pattern from allowlist
/allowlist clear                        # Clear all entries

Development

# Run tests
uv run pytest

# Lint
uv run ruff check .

# Format
uv run ruff format .

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

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

uatu-0.1.9.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

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

uatu-0.1.9-py3-none-any.whl (62.4 kB view details)

Uploaded Python 3

File details

Details for the file uatu-0.1.9.tar.gz.

File metadata

  • Download URL: uatu-0.1.9.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for uatu-0.1.9.tar.gz
Algorithm Hash digest
SHA256 fb407ed6c39980b8d2beb5bde8d9f4843589ef96af0ef49ba5aa518c7ce4c1ca
MD5 f887e328f7eaff4a6390ef1af1276af8
BLAKE2b-256 b1e2658208dc5510c34504e1f6495652d42247c9bbbe17f104b5bab708845691

See more details on using hashes here.

Provenance

The following attestation bundles were made for uatu-0.1.9.tar.gz:

Publisher: publish.yml on fractalops/uatu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file uatu-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: uatu-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 62.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for uatu-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 fecb89e873783af83d6a7112b4442cf5f9043e25e58972122e229d2f6b88c688
MD5 5d0a99d22cf2ce81f7e9e189ae9bb250
BLAKE2b-256 831a813df2736e71de6f338114d36ef4430686ad135608719fae6cbadaccfd71

See more details on using hashes here.

Provenance

The following attestation bundles were made for uatu-0.1.9-py3-none-any.whl:

Publisher: publish.yml on fractalops/uatu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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