Skip to content
Back to search

datastoria

AI-native ClickHouse console for your cluster diagnostics and query generation, optimization and data visualization.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/frankchen021--datastoria/badge.svg)](/listings/frankchen021--datastoria)

HTML

<a href="/listings/frankchen021--datastoria"><img src="/api/listings/frankchen021--datastoria/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 116 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # DataStoria
  2. The AI-native ClickHouse console for your cluster diagnostics, query generation, evidence-based optimization, intelligent visualization.
  3. ## Demo
  4. ![▶ Watch demo](https://s3.datastoria.app/visualization-demo.webp)
  5. 📖 More demo/screenshots at [docs.datastoria.app](https://docs.datastoria.app)
  6. ---
  7. ## 🚀 Key Features
  8. ### 🤖 AI Features
  9. - **Natural Language Data Exploration** — Describe your data needs in plain English and receive optimized ClickHouse queries instantly.
  10. - **Smart Query Optimization** — AI inspects schema, validates SQL, collects evidence, and recommends concrete ClickHouse performance improvements.
  11. - **Intelligent Visualization** — Ask for a chart in plain language and DataStoria generates both the SQL and the visualization spec for time series, bar, pie, and table views.
  12. - **Agent SKILLs Supported** — Skill-based agent architecture that saves tokens across multi-turn conversations; apply the [Official ClickHouse Agent Skills](https://github.com/ClickHouse/agent-skills) to your ClickHouse
  13. - **Multiple Model Providers** — Use OpenAI, Anthropic Claude, Google Gemini, GitHub Copilot, OpenRouter, Groq, Cerebras, Nebius and more.
  14. - **GitHub Copilot Integration** — Sign in with GitHub device flow and use your existing Copilot subscription for chat, query assistance, and other AI-powered workflows.
  15. ### ⚡ Powerful Query Experience
  16. - **Advanced SQL Editor** — Enjoy syntax highlighting, auto-completion, and query formatting for a seamless coding experience.
  17. - **Smart Error Diagnostics** — Pinpoint syntax errors instantly with precise line and column highlighting, and get AI-powered fix suggestions with one click.
  18. - **System Log Inspector** — Dive deep into query execution with timeline views, topology graphs, and performance analysis as well as Materialized Views, ZooKeeper states.
  19. - **One-Click Explain** — Instantly understand query execution plans with visual AST and pipeline views.
  20. - **Dependency Graph** — Visualize table relationships and trace data flows through Materialized Views, Distributed tables, and external systems.
  21. ### 📊 Cluster Monitoring & Management
  22. - **Multi-Cluster Support** — Manage multiple ClickHouse clusters effortlessly from a single interface.
  23. - **Multi-Node Dashboard** — Monitor all nodes with real-time metrics, merge operations, and replication status.
  24. - **Cluster wide Dashboards** — Access pre-configured panels for query performance, ZooKeeper status, and more.
  25. - **Schema Explorer** — Navigate databases, tables, and columns with an intuitive tree view.
  26. ### 🔒 Privacy & Security
  27. - **100% Local Execution** — All SQL queries run directly from your browser to your ClickHouse server, ensuring complete privacy.
  28. - **No Data Collection** — Your credentials and query results never leave your machine.
  29. - **Bring Your Own API Key** — Use your own LLM API keys for AI features, keeping your data under your control.
  30. - **Browser-Side Visualization Rendering** — For AI-generated visualizations, the model produces SQL and chart specs while your browser fetches and renders the data locally.
  31. ---
  32. ## 🌐 Experience the app
  33. Visiting [dataStoria.app](https://datastoria.app) to experience all features without any installation.
  34. ---
  35. ## 🛠️ Build from Source
  36. **Prerequisites:**
  37. - [Node.js](https://nodejs.org/) v22 or later
  38. - [pnpm](https://pnpm.io/) (install via `npm install -g pnpm`)
  39. Follow these steps to build and run locally:
  40. ```bash
  41. # Clone the repository
  42. git clone --recurse-submodules https://github.com/FrankChen021/datastoria.git
  43. cd datastoria
  44. # Install dependencies
  45. npm install --force
  46. # Start the development server
  47. npm run dev
  48. ```
  49. Open [http://localhost:3000](http://localhost:3000) in your browser and connect to your ClickHouse instance.
  50. ---
  51. ## 🐳 Running with Docker
  52. The easiest way to run DataStoria is using the pre-built Docker image:
  53. ```bash
  54. docker run -d -p 3000:3000 frankchen021/datastoria:latest
  55. ```
  56. Then open [http://localhost:3000](http://localhost:3000) in your browser.
  57. The Docker image supports both `linux/amd64` and `linux/arm64` platforms, so it runs natively on Intel/AMD machines as well as Apple Silicon Macs and ARM-based servers.
  58. ---
  59. ## 📖 Documentation
  60. ### User Manual
  61. - [User Manual](https://docs.datastoria.app)
  62. ### Development
  63. - [Docker Deployment](./docker/README.md) — Build and run with Docker
  64. - [LLM Provider API Key Configuration](./doc/dev/llm-provider-api-key.md) — Configure API keys for your LLM provider
  65. - [Authentication Guide](./doc/dev/authentication.md) — OAuth setup for Google, GitHub, and Microsoft
  66. ---
  67. ## 🧰 Tech Stack
  68. - **Framework:** [Next.js](https://nextjs.org/) 16 with React 19
  69. - **AI Integration:** [Vercel AI SDK](https://sdk.vercel.ai/) with support for OpenAI, Anthropic, Google, Groq, and more
  70. - **Authentication:** [NextAuth.js](https://next-auth.js.org/)
  71. ---
  72. ## 📜 License
  73. This project is licensed under the **Apache License 2.0**. See the [LICENSE](./LICENSE) file for details.
  74. ---
  75. DataStoria is an AI-native ClickHouse console for modern query, visualization, and diagnostics workflows.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.