Skip to main content

Open-source visual management tool for Zvec embedded vector database

Project description

English | 中文

Zvec Studio

Visual management tool for the Zvec embedded vector database
Browse data, test queries, and manage schemas — without writing code.

License Version Platforms CI

Zvec Studio guided tour


📦 Installation

Option 1: pip (recommended for developers)

pip install zvec-studio
zvec-studio

Opens http://127.0.0.1:7860 in your browser.

Option 2: Desktop download

Grab the installer for your platform from GitHub Releases:

Platform Architectures Installer
macOS Apple Silicon (arm64) .dmg
Linux x86_64, arm64 .deb / .AppImage
Windows x86_64 .msi / .exe

Double-click to run — no Python needed.

Option 3: From source

git clone https://github.com/zvec-ai/zvec-studio.git
cd zvec-studio
make install    # install Node + Python dependencies
make dev        # starts backend + frontend dev servers

Prerequisites: Node.js ≥ 20, pnpm ≥ 9, Python ≥ 3.10, Rust (desktop only). See Contributing for the full dev setup guide.

⚡ Quick Start

  1. Create a collection — Collections → Create. Define vector and scalar fields.
  2. Insert data — Paste JSON documents in the Write tab.
  3. Vector search — Paste a query vector in the Query tab, set TopK, hit Search.
  4. AI search — Register an embedding model, then search by typing text directly.

Full walkthrough → Getting Started

📖 Documentation

Getting Started 10-minute walkthrough from install to first search
Architecture Request flow, module map, code index
API Reference REST endpoints, request/response formats, error codes
Testing Test strategy, self-verification loop, performance baselines
Packaging PyInstaller + Tauri cross-platform packaging
Contributing Dev setup, code style, commit workflow

🗺️ Roadmap

Version Focus
v0.1.x (current) Collection CRUD, schema evolution, document ops, vector search, AI extension, i18n, desktop app
v0.2.x Data import/export, virtual scrolling, batch operations, advanced search
v0.3.x Vector visualization (UMAP/t-SNE), clustering, AI Agent, SDK code generation
v0.4.x VS Code extension, API Playground, webhooks & notifications

🤝 Contributing

Contributions welcome! See CONTRIBUTING.md for details.

make dev        # Start dev servers
make verify     # Lint + typecheck + tests

📄 License

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zvec_studio-0.1.0rc4-py3-none-any.whl (612.4 kB view details)

Uploaded Python 3

File details

Details for the file zvec_studio-0.1.0rc4-py3-none-any.whl.

File metadata

  • Download URL: zvec_studio-0.1.0rc4-py3-none-any.whl
  • Upload date:
  • Size: 612.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for zvec_studio-0.1.0rc4-py3-none-any.whl
Algorithm Hash digest
SHA256 fb0f02829807b7ecfed7d892a5e038931305df96816207436acbf4e83b3b399b
MD5 d169f768e89e2d7eb342c068e607af85
BLAKE2b-256 5f59d4de636b1dd5eb473b4e4204b002f6ecaa423af37ce81afee3a47c0aa7bd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page