ciris-agent 1.7.7__py3-none-any.whl

ciris_engine/logic/setup/__init__.py

@@ -0,0 +1 @@
+"""First-run setup and configuration management."""

ciris_engine/logic/setup/first_run.py

@@ -0,0 +1,250 @@
+"""First-run detection for CIRIS Agent.
+
+Determines if this is a first-time run by checking for configuration files.
+"""
+
+import logging
+import os
+import platform
+import subprocess
+import sys
+from pathlib import Path
+
+logger = logging.getLogger(__name__)
+
+
+def get_config_paths() -> list[Path]:
+    """Get possible configuration file locations in priority order.
+
+    Uses path_resolution module to detect deployment mode and check appropriate locations.
+
+    Returns:
+        List of paths to check for .env files, in priority order:
+        - Managed mode (Docker/CIRIS Manager):
+          1. /app/.env (manager-provided config)
+        - Android mode:
+          1. CIRIS_HOME/.env (app's files directory)
+        - Development mode (git repo):
+          1. Current directory .env (development/local override)
+          2. ~/ciris/.env (user-specific config)
+          3. /etc/ciris/.env (system-wide config, Linux/Unix)
+        - Installed mode (pip install):
+          1. ~/ciris/.env (user-specific config)
+          2. /etc/ciris/.env (system-wide config, Linux/Unix)
+
+        Note: ~/.ciris/ is for keys/secrets/audit_keys only, NOT config!
+    """
+    from ciris_engine.logic.utils.path_resolution import get_ciris_home, is_android, is_development_mode, is_managed
+
+    paths = []
+
+    # Managed mode: only check /app/.env
+    if is_managed():
+        paths.append(Path("/app/.env"))
+        return paths
+
+    # Android mode: use get_ciris_home() which handles Android-specific paths
+    if is_android():
+        ciris_home = get_ciris_home()
+        paths.append(ciris_home / ".env")
+        logger.info(f"Android mode: checking {ciris_home / '.env'}")
+        return paths
+
+    # Development mode: check current directory first
+    if is_development_mode():
+        paths.append(Path.cwd() / ".env")
+
+    # User config directory (both modes) - ~/ciris/ NOT ~/.ciris/
+    # ~/.ciris/ is for secrets/keys only
+    # NOTE: We use Path.home() / "ciris" directly, NOT get_ciris_home()
+    # get_ciris_home() returns cwd in dev mode, which would duplicate the first path
+    user_ciris_dir = Path.home() / "ciris"
+    paths.append(user_ciris_dir / ".env")
+
+    # System config (Unix/Linux only, both modes)
+    system_config = Path("/etc/ciris/.env")
+    if system_config.parent.exists():  # Only add if /etc/ciris exists
+        paths.append(system_config)
+
+    return paths
+
+
+def is_first_run() -> bool:
+    """Check if this is the first run of CIRIS Agent.
+
+    A first run is detected when:
+    - No .env file exists in any of the standard config locations
+    - No CIRIS_CONFIGURED environment variable is set
+    - OR CIRIS_FORCE_FIRST_RUN is set (for testing)
+
+    In managed/Docker mode: NEVER first-run (manager handles configuration)
+
+    Returns:
+        True if this appears to be a first run, False otherwise.
+    """
+    from ciris_engine.logic.utils.path_resolution import is_managed
+
+    logger.info("Checking first-run status...")
+
+    # Managed mode: NEVER first-run (manager handles configuration)
+    if is_managed():
+        logger.info("Running in MANAGED mode - not first run (manager handles configuration)")
+        return False
+
+    # Log mode detection
+    from ciris_engine.logic.utils.path_resolution import is_development_mode
+
+    dev_mode = is_development_mode()
+    logger.info(f"Running in {'DEVELOPMENT' if dev_mode else 'INSTALLED'} mode (git repo: {dev_mode})")
+
+    # FORCE first-run mode for testing (e.g., QA runner setup tests)
+    force_first_run = os.environ.get("CIRIS_FORCE_FIRST_RUN")
+    logger.info(f"CIRIS_FORCE_FIRST_RUN env var: {force_first_run}")
+    if force_first_run:
+        logger.info("CIRIS_FORCE_FIRST_RUN is set - forcing first-run mode")
+        return True
+
+    # Quick check: If CIRIS_CONFIGURED env var is set, not first run
+    ciris_configured = os.environ.get("CIRIS_CONFIGURED")
+    logger.info(f"CIRIS_CONFIGURED env var: {ciris_configured}")
+    if ciris_configured:
+        logger.info("CIRIS_CONFIGURED is set - not first run")
+        return False
+
+    # Check all possible config locations
+    config_paths = get_config_paths()
+    logger.info(f"Checking config paths: {[str(p) for p in config_paths]}")
+    for path in config_paths:
+        if path.exists() and path.is_file():
+            # Found a config file - not first run
+            logger.info(f"Found config file at {path} - NOT first run")
+            return False
+
+    logger.info("No config files found - IS first run")
+    return True
+
+
+def check_macos_python() -> tuple[bool, str]:
+    """Check if macOS has a valid Python installation.
+
+    On macOS, /usr/bin/python3 is often a stub that requires Xcode Command Line Tools.
+    This function verifies:
+    1. If python3 is the system stub
+    2. If Xcode Command Line Tools are installed
+    3. If Python version is adequate (>= 3.10)
+
+    IMPORTANT: Checks Xcode CLT BEFORE running python3 to avoid triggering
+    the macOS installation dialog popup.
+
+    Returns:
+        Tuple of (is_valid, message)
+    """
+    if platform.system() != "Darwin":
+        return (True, "")  # Not macOS, skip check
+
+    try:
+        # Check which python3 is being used
+        which_result = subprocess.run(["which", "python3"], capture_output=True, text=True, timeout=5)
+        python_path = which_result.stdout.strip()
+
+        # If it's the system stub, check Xcode CLT BEFORE running python3
+        # This prevents the popup dialog
+        if python_path == "/usr/bin/python3":
+            # Check if Xcode Command Line Tools are installed
+            xcode_check = subprocess.run(["xcode-select", "-p"], capture_output=True, timeout=5)
+
+            if xcode_check.returncode != 0:
+                # CLT not installed - DO NOT run python3 (would trigger popup)
+                return (
+                    False,
+                    "macOS system Python detected but Xcode Command Line Tools not installed.\n"
+                    "Install with: xcode-select --install",
+                )
+            # CLT is installed, safe to proceed with version check
+
+        # Only check version if we're sure it won't trigger popup
+        # (either not system stub, or system stub with CLT installed)
+        version_result = subprocess.run(
+            ["python3", "-c", "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')"],
+            capture_output=True,
+            text=True,
+            timeout=5,
+        )
+
+        if version_result.returncode == 0:
+            version_str = version_result.stdout.strip()
+            try:
+                major, minor = map(int, version_str.split("."))
+                if (major, minor) < (3, 10):
+                    return (False, f"Python {version_str} detected. CIRIS requires Python 3.10+")
+            except ValueError:
+                pass  # Couldn't parse version, proceed
+
+        return (True, "")
+
+    except Exception:
+        # If we can't check, assume it's okay and let Python itself fail later
+        return (True, "")
+
+
+def is_interactive_environment() -> bool:
+    """Check if we're running in an interactive environment.
+
+    Non-interactive environments include:
+    - Docker containers (no TTY, DOCKER env var set)
+    - Systemd services (no TTY)
+    - CI/CD pipelines (CI env var set)
+    - Cron jobs (no TTY)
+
+    Returns:
+        True if interactive, False if non-interactive
+    """
+    # Check for CI/CD environments
+    ci_indicators = ["CI", "CONTINUOUS_INTEGRATION", "GITHUB_ACTIONS", "GITLAB_CI", "CIRCLECI"]
+    if any(os.environ.get(var) for var in ci_indicators):
+        return False
+
+    # Check for Docker environment
+    if os.environ.get("DOCKER") or os.path.exists("/.dockerenv"):
+        return False
+
+    # Check for systemd/service environment
+    if os.environ.get("INVOCATION_ID"):  # systemd sets this
+        return False
+
+    # Check if stdin/stdout are TTY
+    if not sys.stdin.isatty() or not sys.stdout.isatty():
+        return False
+
+    return True
+
+
+def get_default_config_path() -> Path:
+    """Get the default path where config should be saved.
+
+    Returns:
+        Path to save .env file:
+        - Android app files/ciris/.env if on Android
+        - Current directory if it's a git repo (development)
+        - ~/ciris/.env otherwise (user install)
+
+        Note: ~/.ciris/ is for keys/secrets only, NOT config!
+    """
+    from ciris_engine.logic.utils.path_resolution import get_ciris_home, is_android, is_development_mode
+
+    # Android mode - use get_ciris_home() which handles Android paths
+    if is_android():
+        ciris_home = get_ciris_home()
+        ciris_home.mkdir(parents=True, exist_ok=True)
+        logger.info(f"Android mode: config path is {ciris_home / '.env'}")
+        return ciris_home / ".env"
+
+    # Development mode - save in current directory
+    if is_development_mode():
+        return Path.cwd() / ".env"
+
+    # Production/user install - save in ~/ciris/ (NOT ~/.ciris/)
+    # ~/.ciris/ is for secrets/keys only
+    user_ciris_dir = Path.home() / "ciris"
+    user_ciris_dir.mkdir(parents=True, exist_ok=True)
+    return user_ciris_dir / ".env"

ciris_engine/logic/setup/wizard.py

@@ -0,0 +1,327 @@
+"""Interactive setup wizard for first-run CIRIS configuration.
+
+Mirrors the functionality of scripts/install.sh env creation (lines 673-849).
+"""
+
+import logging
+import secrets
+import sys
+from datetime import datetime
+from pathlib import Path
+from typing import Optional
+
+from ciris_engine.config.ciris_services import get_billing_url
+from ciris_engine.constants import CIRIS_VERSION
+
+logger = logging.getLogger(__name__)
+
+
+def generate_encryption_key() -> str:
+    """Generate a secure 32-byte base64-encoded encryption key.
+
+    Equivalent to: openssl rand -base64 32
+
+    Returns:
+        Base64-encoded random key
+    """
+    random_bytes = secrets.token_bytes(32)
+    import base64
+
+    return base64.b64encode(random_bytes).decode("utf-8")
+
+
+def prompt_llm_configuration() -> tuple[str, str, str, str]:
+    """Interactively prompt for LLM configuration.
+
+    Returns:
+        Tuple of (provider, api_key, base_url, model)
+    """
+    print("\n" + "=" * 70)
+    print("LLM CONFIGURATION")
+    print("=" * 70)
+    print()
+    print("CIRIS can work with OpenAI or any OpenAI-compatible LLM provider.")
+    print()
+    print("Options:")
+    print("  1) OpenAI (requires API key)")
+    print("  2) Local LLM (Ollama, LM Studio, vLLM, etc.)")
+    print("  3) Other provider (Together AI, Groq, Fireworks, etc.)")
+    print()
+
+    choice = input("Select option [1-3] (default: 1): ").strip() or "1"
+
+    if choice == "1":
+        # OpenAI
+        print()
+        api_key = input("Enter your OpenAI API key (or press Enter to skip): ").strip()
+        if not api_key:
+            print("⚠️  No API key provided. You'll need to add it to .env later.")
+            api_key = "your_openai_api_key_here"
+        return ("openai", api_key, "", "")
+
+    elif choice == "2":
+        # Local LLM
+        print()
+        print("Local LLM Setup")
+        print("Popular options:")
+        print("  - Ollama:    http://localhost:11434")
+        print("  - LM Studio: http://localhost:1234/v1")
+        print("  - vLLM:      http://localhost:8000/v1")
+        print("  - LocalAI:   http://localhost:8080/v1")
+        print()
+
+        base_url = input("Enter LLM base URL (default: http://localhost:11434): ").strip()
+        base_url = base_url or "http://localhost:11434"
+
+        model = input("Enter model name (default: llama3): ").strip()
+        model = model or "llama3"
+
+        api_key = input("Enter API key (or 'local' if no auth) (default: local): ").strip()
+        api_key = api_key or "local"
+
+        return ("local", api_key, base_url, model)
+
+    else:
+        # Other provider
+        print()
+        print("Other OpenAI-Compatible Provider")
+        print()
+        print("Popular providers:")
+        print("  - Together AI: https://api.together.xyz/v1")
+        print("  - Groq:        https://api.groq.com/openai/v1")
+        print("  - Fireworks:   https://api.fireworks.ai/inference/v1")
+        print("  - Anyscale:    https://api.endpoints.anyscale.com/v1")
+        print()
+
+        base_url = input("Enter API base URL: ").strip()
+        if not base_url:
+            print("❌ Base URL required for custom providers")
+            sys.exit(1)
+
+        model = input("Enter model name: ").strip()
+        if not model:
+            print("❌ Model name required")
+            sys.exit(1)
+
+        api_key = input("Enter API key: ").strip()
+        if not api_key:
+            print("❌ API key required for commercial providers")
+            sys.exit(1)
+
+        return ("other", api_key, base_url, model)
+
+
+def create_env_file(
+    save_path: Path,
+    llm_provider: str,
+    llm_api_key: str,
+    llm_base_url: str,
+    llm_model: str,
+    agent_port: int = 8080,
+) -> None:
+    """Create .env configuration file.
+
+    Args:
+        save_path: Where to save the .env file
+        llm_provider: LLM provider type (openai, local, other)
+        llm_api_key: API key for LLM
+        llm_base_url: Base URL for OpenAI-compatible endpoint
+        llm_model: Model name
+        agent_port: Port for agent API (default: 8080)
+    """
+    # Log what we received for debugging
+    logger.info(f"[create_env_file] Received llm_provider='{llm_provider}', llm_base_url='{llm_base_url}'")
+
+    # Generate encryption keys
+    secrets_key = generate_encryption_key()
+    telemetry_key = generate_encryption_key()
+
+    # Build .env content with version marker
+    content = f"""# ENV GENERATED BY CIRIS AGENT VERSION {CIRIS_VERSION}
+# Generated on {datetime.now().strftime("%Y-%m-%d %H:%M:%S")}
+# LLM Provider: {llm_provider}
+
+# ============================================================================
+# LLM Configuration
+# ============================================================================
+
+"""
+
+    if llm_provider == "openai":
+        content += f"""# OpenAI Configuration
+OPENAI_API_KEY="{llm_api_key}"
+
+# Optional: Use a different OpenAI model
+# OPENAI_MODEL="gpt-4"
+
+# Optional: Use OpenAI-compatible endpoint
+# OPENAI_API_BASE="https://api.openai.com/v1"
+
+"""
+    else:
+        content += f"""# OpenAI-Compatible LLM Configuration
+OPENAI_API_KEY="{llm_api_key}"
+OPENAI_API_BASE="{llm_base_url}"
+OPENAI_MODEL="{llm_model}"
+
+"""
+        # If using CIRIS LLM proxy, also set billing token and instructor mode
+        if "ciris.ai" in llm_base_url.lower() or "ciris-services" in llm_base_url.lower():
+            # Determine billing URL based on LLM proxy URL (match region)
+            use_eu_fallback = "ciris-services-2" in llm_base_url.lower()
+            billing_url = get_billing_url(use_fallback=use_eu_fallback)
+
+            content += f"""# CIRIS Billing Configuration (Android - uses Google ID token for JWT auth)
+CIRIS_BILLING_GOOGLE_ID_TOKEN="{llm_api_key}"
+CIRIS_BILLING_API_URL="{billing_url}"
+
+# CIRIS Proxy uses JSON mode for Maverick (native structured output support)
+INSTRUCTOR_MODE="JSON"
+
+"""
+
+        content += """# Popular OpenAI-compatible providers:
+#
+# Local Models:
+#   Ollama:    http://localhost:11434
+#   LM Studio: http://localhost:1234/v1
+#   vLLM:      http://localhost:8000/v1
+#   LocalAI:   http://localhost:8080/v1
+#
+# Commercial Providers:
+#   Together AI: https://api.together.xyz/v1
+#   Groq:        https://api.groq.com/openai/v1
+#   Fireworks:   https://api.fireworks.ai/inference/v1
+#   Anyscale:    https://api.endpoints.anyscale.com/v1
+
+"""
+
+    content += f"""# ============================================================================
+# Security Keys (auto-generated)
+# ============================================================================
+
+SECRETS_MASTER_KEY="{secrets_key}"
+TELEMETRY_ENCRYPTION_KEY="{telemetry_key}"
+
+# ============================================================================
+# Application Configuration
+# ============================================================================
+
+# Log Level
+LOG_LEVEL="INFO"
+
+# Ports
+CIRIS_AGENT_PORT={agent_port}
+CIRIS_API_PORT={agent_port}
+NEXT_PUBLIC_API_BASE_URL="http://localhost:{agent_port}"
+
+# Database Paths (using ~/ciris as base directory)
+CIRIS_DB_PATH="~/ciris/data/ciris_engine.db"
+CIRIS_DATA_DIR="~/ciris/data"
+SECRETS_DB_PATH="~/ciris/data/secrets.db"
+AUDIT_LOG_PATH="~/ciris/data/audit_logs.jsonl"
+
+# Mark as configured
+CIRIS_CONFIGURED="true"
+
+# ============================================================================
+# Optional: Discord Integration
+# ============================================================================
+
+# Uncomment and configure if using Discord adapter
+# DISCORD_BOT_TOKEN="your_discord_bot_token_here"
+# DISCORD_CHANNEL_ID="your_channel_id_here"
+
+# ============================================================================
+# Optional: Reddit Integration
+# ============================================================================
+
+# Uncomment and configure if using Reddit adapter
+# CIRIS_REDDIT_CLIENT_ID="your_client_id"
+# CIRIS_REDDIT_CLIENT_SECRET="your_client_secret"
+# CIRIS_REDDIT_USERNAME="your_username"
+# CIRIS_REDDIT_PASSWORD="your_password"
+
+# ============================================================================
+# Optional: Production Settings
+# ============================================================================
+
+# CIRISNode Configuration
+# CIRISNODE_BASE_URL="https://your-cirisnode.com:8001"
+# CIRISNODE_AGENT_SECRET_JWT="your_jwt_token"
+"""
+
+    # Write file
+    save_path.parent.mkdir(parents=True, exist_ok=True)
+    save_path.write_text(content, encoding="utf-8")
+
+
+def run_setup_wizard(save_path: Optional[Path] = None) -> Path:
+    """Run the interactive setup wizard.
+
+    Args:
+        save_path: Where to save .env file (None = auto-detect)
+
+    Returns:
+        Path where .env was saved
+    """
+    from ciris_engine.logic.setup.first_run import get_default_config_path
+
+    if save_path is None:
+        save_path = get_default_config_path()
+
+    print()
+    print("=" * 70)
+    print(" " * 20 + "CIRIS AGENT SETUP")
+    print("=" * 70)
+    print()
+    print("Welcome to CIRIS! This wizard will help you configure your agent.")
+    print()
+
+    # Check if config already exists
+    if save_path.exists():
+        print(f"⚠️  Configuration already exists at: {save_path}")
+        overwrite = input("Overwrite? [y/N] ").strip().lower()
+        if overwrite not in ("y", "yes"):
+            print("Setup cancelled. Using existing configuration.")
+            return save_path
+
+    # Get LLM configuration
+    llm_provider, llm_api_key, llm_base_url, llm_model = prompt_llm_configuration()
+
+    # Create .env file
+    print()
+    print(f"Creating configuration at: {save_path}")
+    create_env_file(
+        save_path=save_path,
+        llm_provider=llm_provider,
+        llm_api_key=llm_api_key,
+        llm_base_url=llm_base_url,
+        llm_model=llm_model,
+    )
+
+    print()
+    print("=" * 70)
+    print("✅ SETUP COMPLETE")
+    print("=" * 70)
+    print()
+    print(f"Configuration saved to: {save_path}")
+    print()
+
+    if llm_api_key in ("your_openai_api_key_here", ""):
+        print("⚠️  Remember to add your LLM API key to the .env file!")
+        print()
+
+    print("Starting CIRIS Agent...")
+    print()
+    print("Once started, you can access:")
+    print("  🌐 Web Interface: http://localhost:8080")
+    print("  📡 API Endpoint:  http://localhost:8080/v1/")
+    print("  📚 API Docs:      http://localhost:8080/docs")
+    print()
+    print("Default credentials:")
+    print("  Username: admin")
+    print("  Password: ciris_admin_password")
+    print()
+
+    return save_path

ciris_engine/logic/telemetry/__init__.py

@@ -0,0 +1,46 @@
+"""
+CIRIS Agent Telemetry System
+
+Provides comprehensive observability while maintaining security and agent self-awareness.
+All telemetry data is considered potentially sensitive and processed through security filters.
+
+Key principles:
+- Safety First: No PII or conversation content in metrics
+- Agent Self-Awareness: Full visibility into own metrics via SystemSnapshot
+- Secure by Default: All external endpoints require authentication and TLS
+- Fail Secure: Telemetry failures don't affect agent operation
+"""
+
+from .core import BasicTelemetryCollector
+
+# Note: collectors module not yet implemented
+# from .collectors import (
+#     BaseCollector,
+#     InstantCollector,
+#     FastCollector,
+#     NormalCollector,
+#     SlowCollector,
+#     AggregateCollector,
+#     CollectorManager,
+#     MetricData
+# )
+from .log_collector import LogCorrelationCollector, TSDBLogHandler
+from .resource_monitor import ResourceMonitor, ResourceSignalBus
+from .security import SecurityFilter
+
+__all__ = [
+    "ResourceMonitor",
+    "ResourceSignalBus",
+    "BasicTelemetryCollector",
+    "SecurityFilter",
+    # "BaseCollector",
+    # "InstantCollector",
+    # "FastCollector",
+    # "NormalCollector",
+    # "SlowCollector",
+    # "AggregateCollector",
+    # "CollectorManager",
+    # "MetricData",
+    "LogCorrelationCollector",
+    "TSDBLogHandler",
+]