onesearch-cli 0.12.1__py3-none-any.whl

onesearch/config.py

@@ -0,0 +1,185 @@
+# Copyright (C) 2025 demigodmode
+# SPDX-License-Identifier: AGPL-3.0-only
+
+"""Configuration management for OneSearch CLI."""
+
+import os
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+
+def get_config_dir() -> Path:
+    """Get the configuration directory path."""
+    # Use XDG_CONFIG_HOME on Linux, or appropriate dir on Windows/Mac
+    if os.name == "nt":  # Windows
+        config_base = Path(os.environ.get("APPDATA", Path.home() / "AppData" / "Roaming"))
+    else:  # Linux/Mac
+        config_base = Path(os.environ.get("XDG_CONFIG_HOME", Path.home() / ".config"))
+    return config_base / "onesearch"
+
+
+def get_config_path() -> Path:
+    """Get the configuration file path."""
+    return get_config_dir() / "config.yml"
+
+
+def load_config() -> dict:
+    """Load configuration from file.
+
+    Returns:
+        Configuration dictionary, or empty dict if file doesn't exist.
+    """
+    config_path = get_config_path()
+    if not config_path.exists():
+        return {}
+
+    try:
+        with open(config_path) as f:
+            config = yaml.safe_load(f) or {}
+            return config
+    except Exception:
+        return {}
+
+
+def save_config(config: dict) -> None:
+    """Save configuration to file.
+
+    Args:
+        config: Configuration dictionary to save.
+    """
+    config_dir = get_config_dir()
+    config_dir.mkdir(parents=True, exist_ok=True)
+
+    config_path = get_config_path()
+    with open(config_path, "w") as f:
+        yaml.safe_dump(config, f, default_flow_style=False, sort_keys=False)
+
+
+def get_config_value(key: str, default: Any = None) -> Any:
+    """Get a configuration value.
+
+    Args:
+        key: Dot-separated key path (e.g., "output.colors").
+        default: Default value if key not found.
+
+    Returns:
+        Configuration value or default.
+    """
+    config = load_config()
+    keys = key.split(".")
+    value = config
+
+    for k in keys:
+        if isinstance(value, dict) and k in value:
+            value = value[k]
+        else:
+            return default
+
+    return value
+
+
+def set_config_value(key: str, value: Any) -> None:
+    """Set a configuration value.
+
+    Args:
+        key: Dot-separated key path (e.g., "output.colors").
+        value: Value to set.
+    """
+    config = load_config()
+    keys = key.split(".")
+
+    # Navigate to the parent dict
+    current = config
+    for k in keys[:-1]:
+        if k not in current or not isinstance(current[k], dict):
+            current[k] = {}
+        current = current[k]
+
+    # Set the value
+    current[keys[-1]] = value
+    save_config(config)
+
+
+def delete_config_value(key: str) -> bool:
+    """Delete a configuration value.
+
+    Args:
+        key: Dot-separated key path.
+
+    Returns:
+        True if value was deleted, False if not found.
+    """
+    config = load_config()
+    keys = key.split(".")
+
+    # Navigate to the parent dict
+    current = config
+    for k in keys[:-1]:
+        if k not in current or not isinstance(current[k], dict):
+            return False
+        current = current[k]
+
+    # Delete the key
+    if keys[-1] in current:
+        del current[keys[-1]]
+        save_config(config)
+        return True
+    return False
+
+
+def get_backend_url() -> str:
+    """Get the backend URL from config/env/default.
+
+    Priority:
+    1. Environment variable ONESEARCH_URL
+    2. Config file backend_url
+    3. Default http://localhost:8000
+    """
+    env_url = os.environ.get("ONESEARCH_URL")
+    if env_url:
+        return env_url
+
+    config_url = get_config_value("backend_url")
+    if config_url:
+        return config_url
+
+    return "http://localhost:8000"
+
+
+def get_auth_token() -> str | None:
+    """Get auth token from env/config.
+
+    Priority:
+    1. Environment variable ONESEARCH_TOKEN
+    2. Config file auth.token
+    """
+    env_token = os.environ.get("ONESEARCH_TOKEN")
+    if env_token:
+        return env_token
+
+    return get_config_value("auth.token")
+
+
+# Default configuration template
+DEFAULT_CONFIG = """\
+# OneSearch CLI Configuration
+# Location: {config_path}
+
+# Backend API URL
+backend_url: http://localhost:8000
+
+# Authentication
+auth:
+  token: null
+
+# Output settings
+output:
+  colors: true
+  format: table  # table or json
+
+# Default values for commands
+defaults:
+  search_limit: 20
+"""

onesearch/context.py

@@ -0,0 +1,51 @@
+# Copyright (C) 2025 demigodmode
+# SPDX-License-Identifier: AGPL-3.0-only
+
+"""Shared CLI context and utilities."""
+
+import io
+
+import click
+from rich.console import Console
+
+from onesearch.api import OneSearchAPI
+from onesearch.config import get_auth_token
+
+# Rich console for output
+console = Console()
+err_console = Console(stderr=True)
+
+# Quiet console that discards output
+_quiet_console = Console(file=io.StringIO(), force_terminal=False)
+
+
+class Context:
+    """CLI context object passed to commands."""
+
+    def __init__(self):
+        self.api: OneSearchAPI | None = None
+        self.verbose: bool = False
+        self.quiet: bool = False
+        self.url: str = "http://localhost:8000"
+        self.token: str | None = None
+
+    def get_api(self) -> OneSearchAPI:
+        """Get or create the API client."""
+        if self.api is None:
+            self.token = get_auth_token()
+            self.api = OneSearchAPI(base_url=self.url, token=self.token)
+        return self.api
+
+    def reset_api(self) -> None:
+        """Clear cached API client after config/auth changes."""
+        self.api = None
+        self.token = None
+
+    def get_console(self) -> Console:
+        """Get the appropriate console based on quiet mode."""
+        if self.quiet:
+            return _quiet_console
+        return console
+
+
+pass_context = click.make_pass_decorator(Context, ensure=True)

onesearch/main.py

@@ -0,0 +1,153 @@
+# Copyright (C) 2025 demigodmode
+# SPDX-License-Identifier: AGPL-3.0-only
+
+"""OneSearch CLI entry point."""
+
+import os
+import sys
+
+import click
+
+from onesearch import __version__
+from onesearch.api import APIError
+from onesearch.banner import build_startup_panel
+from onesearch.config import load_config
+from onesearch.context import Context, console, err_console
+
+# Context settings for all commands
+CONTEXT_SETTINGS = {
+    "help_option_names": ["-h", "--help"],
+}
+
+
+def get_default_url() -> str:
+    """Get the default backend URL from config/env/default."""
+    from onesearch.config import get_backend_url
+    return get_backend_url()
+
+
+def _has_configured_backend(resolved_url: str | None = None) -> bool:
+    config_data = load_config()
+    return bool(resolved_url or os.environ.get("ONESEARCH_URL") or config_data.get("backend_url"))
+
+
+def _render_startup_panel(ctx: Context) -> None:
+    configured = _has_configured_backend(ctx.url)
+    if not configured:
+        console.print(
+            build_startup_panel(
+                configured=False,
+                backend_url=None,
+                cli_version=__version__,
+            )
+        )
+        return
+
+    api = ctx.get_api()
+    try:
+        health = api.health(allow_degraded=True)
+        server_version = health.get("version")
+        server_status = health.get("status", "unknown")
+        auth_state = "not logged in"
+
+        try:
+            user = api.whoami()
+            auth_state = f"logged in as {user.get('username', 'unknown')}"
+        except APIError as auth_error:
+            if auth_error.status_code not in (401, 403):
+                console.print(
+                    build_startup_panel(
+                        configured=True,
+                        backend_url=ctx.url,
+                        cli_version=__version__,
+                        server_version=server_version,
+                        server_status=server_status,
+                        error_message=auth_error.message,
+                    )
+                )
+                return
+
+        console.print(
+            build_startup_panel(
+                configured=True,
+                backend_url=ctx.url,
+                cli_version=__version__,
+                server_version=server_version,
+                server_status=server_status,
+                auth_state=auth_state,
+            )
+        )
+    except APIError as e:
+        console.print(
+            build_startup_panel(
+                configured=True,
+                backend_url=ctx.url,
+                cli_version=__version__,
+                error_message=e.message,
+            )
+        )
+
+
+@click.group(context_settings=CONTEXT_SETTINGS, invoke_without_command=True)
+@click.version_option(version=__version__, prog_name="onesearch")
+@click.option(
+    "--url",
+    envvar="ONESEARCH_URL",
+    default=get_default_url,
+    help="Backend API URL.",
+    show_default=True,
+)
+@click.option(
+    "-v", "--verbose",
+    is_flag=True,
+    help="Enable verbose output.",
+)
+@click.option(
+    "-q", "--quiet",
+    is_flag=True,
+    help="Suppress non-essential output. Only show results/errors.",
+)
+@click.pass_context
+def cli(click_ctx: click.Context, url: str, verbose: bool, quiet: bool):
+    """OneSearch - Self-hosted, privacy-focused search for your homelab.
+
+    Search across all your files, documents, and notes from a single,
+    unified command-line interface.
+
+    \b
+    Examples:
+      onesearch search "kubernetes deployment"
+      onesearch source list
+      onesearch status
+      onesearch health
+
+    Use 'onesearch COMMAND --help' for more information on a command.
+    """
+    ctx = click_ctx.ensure_object(Context)
+    ctx.url = url
+    ctx.verbose = verbose
+    ctx.quiet = quiet
+
+    if click_ctx.invoked_subcommand is None:
+        _render_startup_panel(ctx)
+
+
+# Import and register command groups after cli is defined
+from onesearch.commands import auth, config, search, source, status  # noqa: E402, F401
+
+
+def main():
+    """Main entry point."""
+    try:
+        cli()
+    except KeyboardInterrupt:
+        err_console.print("\n[yellow]Aborted.[/yellow]")
+        sys.exit(130)
+    except Exception as e:
+        # Show concise error; users can use -v for more details
+        err_console.print(f"[red]Error:[/red] {type(e).__name__}: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

onesearch_cli-0.12.1.dist-info/METADATA

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: onesearch-cli
+Version: 0.12.1
+Summary: Standalone CLI client for a running OneSearch server
+License: AGPL-3.0-only
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: rich>=13.0.0
+Description-Content-Type: text/markdown
+
+# OneSearch CLI
+
+Command-line interface for OneSearch - Self-hosted, privacy-focused search for your homelab.
+
+## Installation
+
+The CLI is a standalone client for a running OneSearch server. It does not include the backend, indexer, or search data. Tagged OneSearch releases publish the Docker image and the `onesearch-cli` package together on the same shared version.
+
+### Recommended: pipx
+
+```bash
+pipx install onesearch-cli
+onesearch config set backend_url http://localhost:8000
+onesearch login
+```
+
+### From Source (Development)
+
+```bash
+cd cli
+python -m venv .venv
+
+# Windows
+.venv\Scripts\activate
+
+# Linux/Mac
+source .venv/bin/activate
+
+pip install -e .
+```
+
+### Verify Installation
+
+```bash
+onesearch --version
+onesearch --help
+```
+
+## Quick Start
+
+```bash
+# Check system health
+onesearch health
+
+# List configured sources
+onesearch source list
+
+# Add a source (ID is auto-generated from name as slug, e.g., "documents")
+onesearch source add "Documents" /data/docs --include "**/*.pdf,**/*.md"
+
+# Trigger indexing (use source ID from 'source list')
+onesearch source reindex documents
+
+# Search
+onesearch search "kubernetes deployment"
+
+# Check indexing status
+onesearch status
+```
+
+> **Note:** Source IDs are slugified from the name (e.g., "My Documents" → "my-documents").
+
+## Commands
+
+### Source Management
+
+```bash
+# List all sources
+onesearch source list
+
+# Add a new source
+onesearch source add <name> <path> [--include PATTERNS] [--exclude PATTERNS]
+
+# Show source details
+onesearch source show <source_id>
+
+# Reindex a source
+onesearch source reindex <source_id>
+
+# Delete a source
+onesearch source delete <source_id> [--yes]
+```
+
+### Search
+
+```bash
+# Basic search
+onesearch search "query"
+
+# With filters (use source ID from 'source list')
+onesearch search "python" --source documents --type pdf --limit 10
+
+# JSON output for scripting
+onesearch search "error" --json | jq '.results[].path'
+
+# Pagination
+onesearch search "docker" --offset 20 --limit 10
+```
+
+### Status & Health
+
+```bash
+# Overall status
+onesearch status
+
+# Specific source status
+onesearch status <source_id>
+
+# System health check
+onesearch health
+
+# JSON output for monitoring
+onesearch health --json
+```
+
+## Configuration
+
+### Environment Variables
+
+- `ONESEARCH_URL` - Backend API URL (default: `http://localhost:8000`)
+- `ONESEARCH_TOKEN` - Bearer token for non-interactive auth
+
+```bash
+# Use a custom backend URL
+export ONESEARCH_URL=http://onesearch.local:8000
+onesearch search "test"
+
+# Non-interactive auth for scripts
+export ONESEARCH_TOKEN=xxxxx
+onesearch search "test" --json
+
+# Or pass the URL directly
+onesearch --url http://onesearch.local:8000 search "test"
+```
+
+### Global Options
+
+- `--url URL` - Override backend API URL
+- `-v, --verbose` - Enable verbose output
+- `-q, --quiet` - Suppress non-essential output (headers, hints, decorations)
+- `-h, --help` - Show help message
+- `--version` - Show version
+
+## Output Formats
+
+Most commands support `--json` for machine-readable output:
+
+```bash
+# JSON for scripting
+onesearch health --json
+onesearch status --json
+onesearch search "test" --json
+```
+
+## Examples
+
+### Add and Index a Source
+
+```bash
+# Add a documents source (creates ID "my-documents")
+onesearch source add "My Documents" /mnt/nas/documents \
+  --include "**/*.pdf,**/*.md,**/*.txt" \
+  --exclude "**/archive/**"
+
+# Start indexing (use the source ID)
+onesearch source reindex my-documents
+
+# Monitor progress
+onesearch status my-documents
+```
+
+> **Docker users:** If the path only exists inside the container, use `--no-validate` to skip local path validation:
+> ```bash
+> onesearch source add "NAS Docs" /data/nas --no-validate
+> ```
+
+### Search with Filters
+
+```bash
+# Search PDFs only
+onesearch search "quarterly report" --type pdf
+
+# Search specific source (use source ID)
+onesearch search "meeting notes" --source my-documents
+
+# Get more results
+onesearch search "python" --limit 50
+```
+
+### Health Monitoring
+
+```bash
+# Quick health check (returns non-zero on failure)
+onesearch health || echo "OneSearch is down!"
+
+# JSON for monitoring systems
+onesearch health --json | jq '.status'
+```
+
+## Development
+
+```bash
+# Install CLI in development mode
+pip install -e .
+
+# Run tests (install pytest first)
+pip install pytest
+pytest
+```

onesearch_cli-0.12.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+onesearch/__init__.py,sha256=CNzQ2BVpOiKjVj9EVq-K42qipFQTcmqJyouwfP5QR2A,159
+onesearch/api.py,sha256=rLqWMcBU8fcI4wrCu-BSdk_I9zMqRu5EHz5YKh03jkE,7819
+onesearch/banner.py,sha256=bBUaJ57kJuLtVYHogc628A8dvA_YdygvpFzFdCzr3XE,2244
+onesearch/config.py,sha256=_0lMbXk3Hy6chW1pmPMVkK8kSBPfmqTsl6PTsbSh98s,4252
+onesearch/context.py,sha256=kMCRiR7_fTbISktPevZDmhQqQ8J6tdBMc1pKRyYOxcc,1382
+onesearch/main.py,sha256=ZmRglroIaAjrgTFhSY1p6EMuYVSJx3ZLzmLIT5RhzSM,4360
+onesearch/commands/__init__.py,sha256=VvkpGc4aV5zn_mUTyW06pKm_wlcCkSIvevmyM5O_v3M,102
+onesearch/commands/auth.py,sha256=Jh_VKaSJtHcqboh-jHNA9yzkTVVW8ysE6c4nTaFwuho,2040
+onesearch/commands/config.py,sha256=kixtrN5aFi8_JfXb9nhcjDgjk7v7RCZmoQn29wqQcTM,4761
+onesearch/commands/search.py,sha256=Oxn6y8tQnXY_Msf22B08PfB5taijZkwGtXKaRtMMlFI,4833
+onesearch/commands/source.py,sha256=snNnCtoAuQOw1Bh9J6SYCrhE8Uw-_fYyMupnE-043tc,8256
+onesearch/commands/status.py,sha256=2kqJAPMlD467QRn0z480T1MFOQmG1cnir62rE4s1Xb4,8191
+onesearch_cli-0.12.1.dist-info/METADATA,sha256=zNg24frjkscREjp7dpcKO-lXDRzc-JXdpobCQj_OV3s,4623
+onesearch_cli-0.12.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+onesearch_cli-0.12.1.dist-info/entry_points.txt,sha256=WdfuKdCaH4rLJIwtZZBmC3zZ_l0PyGNuDvvg5m2UJiE,49
+onesearch_cli-0.12.1.dist-info/RECORD,,

onesearch_cli-0.12.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

onesearch_cli-0.12.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+onesearch = onesearch.main:cli