onesearch-cli 0.12.1__tar.gz

onesearch_cli-0.12.1/.gitignore

@@ -0,0 +1,77 @@
+# Environment
+.env
+.env.local
+.env.*.local
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+.venv/
+env/
+ENV/
+
+# Database
+*.db
+*.db-journal
+*.db-wal
+*.db-shm
+data/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+*.cover
+.tox/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Frontend
+node_modules/
+dist/
+*.local
+!frontend/src/lib/
+
+# Logs
+*.log
+logs/
+
+# Docker
+*.env.production
+docker-compose.override.yml
+
+# Alembic
+alembic/versions/*.pyc
+
+# Local documentation (not pushed to GitHub)
+local_docs/
+
+# MkDocs build output
+site/

onesearch_cli-0.12.1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,209 @@
+# 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/onesearch/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (C) 2025 demigodmode
+# SPDX-License-Identifier: AGPL-3.0-only
+
+"""OneSearch CLI - Command-line interface for OneSearch."""
+
+__version__ = "0.12.1"