spotdb

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2025 License: MIT Imports: 9 Imported by: 0

README

SpotDB

Quality Gate Status

Lightweight data sandbox for AI workflows and data exploration, enabled with guardrails and security to keep your data safe.

This project provides a lightweight, ephemeral data sandbox designed for large language models (LLMs) and agentic workflows. By providing a secure, isolated environment, it allows AI agents and scripts to analyze data without direct access to production databases. This setup prevents accidental data modification, ensures data privacy, and enforces guardrails for safe data exploration.

Features

  • 🏖️ Ephemeral Data Sandbox: Create temporary databases for AI workflows and data exploration.
  • 📸 Snapshot: Capture and store data snapshots, recover point-in-time data states or continue from a previous state.
  • 🧠 MCP API: Access data through a Model Context Protocol for seamless integration with AI models and agentic workflows.
  • ⚙️ REST API: Access data through a RESTful API for integration with traditional systems and workflows.
  • 🚂 Guardrails: Enforce rules and constraints to ensure data safety and privacy.
  • 🛡️ Security: Protect data from unauthorized access and modification.

Quick Start

  1. Tap the repository and install the package:
brew tap aliengiraffe/spaceship && \\
brew install spotdb
  1. Start the server:
spotdb
  1. Upload a CSV file:
curl -X POST \
  http://localhost:8080/api/v1/upload \
  -F "table_name=mytable" \
  -F "has_header=true" \
  -F "csv_file=@data.csv"
  1. Query the data:
curl -X POST \
  http://localhost:8080/api/v1/query \
  -H "Content-Type: application/json" \
  -d '{"query": "SELECT * FROM mytable LIMIT 10"}'
  1. Setup Claude Code You must have the claude command installed.

Then, you can add the spotdb mcp:

claude mcp add spotdb -s user -- npx -y mcp-remote http://localhost:8081/stream

Use Explorer UI

Open the Explorer UI in your browser and upload files and query the data:

open http://localhost:8080/explorer

Full Documentation

👉 https://github.com/aliengiraffe/spotdb/blob/main/DOCS.md

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
app
cli command
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
vcs
pkg
api
log
mcp

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL