Weaviate StudioA VS Code extension for managing Weaviate vector database instances, browsing collections, and visualizing data. Installation Launch VS Code Quick Open ( Ctrl+P), paste the following command, and press enter.Copied to clipboard |
|
Weaviate Studio
| VS Code | Cursor | Windsurf | Manual Install |
|---|---|---|---|
| Marketplace | Open VSX | Open VSX | Download VSIX |
Top Features
- Multiple Connections: Manage several Weaviate instances at once
- Data Explorer: Interactive visual browser with advanced filtering, 4 vector search modes (text, object, vector, hybrid), and JSON/CSV export
- Backup & Restore: Create, monitor, and restore backups across multiple backends (filesystem, S3, GCS, Azure)
- Cluster Management: Comprehensive cluster information panel with health monitoring
- Schema Explorer: Visualize and browse collections, properties, and nested object structures
- Advanced Query Editor: Monaco-powered GraphQL editor with intelligent, schema-aware templates
- Live Results: Table and JSON views for query results
- Secure Storage: Credentials stored with VS Code's secret storage
- Modern UI: Responsive, dark-theme optimized interface
Getting Started
New to Weaviate? 🚀
Try our quick local sandbox with Docker! Perfect for learning and development:
cd sandbox
docker-compose up -d
python3 populate.py
This spins up a fully-configured Weaviate instance with sample jeopardy questions, vector embeddings, and backup support enabled. Learn more →
Connecting to Weaviate
- Install Weaviate Studio from the VS Code Marketplace or Open VSX.
- Open the Weaviate Studio panel from the VS Code sidebar.
- Add a connection to your Weaviate instance (local, on-prem, or cloud).
- Explore your schema, run queries, and manage your data—all within VS Code!
Full Feature List
Connection Management
- Connect to multiple Weaviate instances simultaneously
- Secure credential storage with VS Code's built-in secret storage
- Connection health monitoring and automatic reconnection
- Cloud and Custom endpoints with API key support for Cloud
- Advanced options: per-operation timeouts and skip-initialization checks
- API keys are not displayed when editing existing connections
- Optional connect‑on‑expand prompt for disconnected connections
Data Explorer
- Interactive table browser with sortable columns and pagination
- Visual filter builder with 10+ operators and AND/OR logic
- Four vector search modes: Text, Object, Vector, and Hybrid (BM25 + semantic)
- Alpha slider for balancing keyword vs semantic search
- Export to JSON/CSV with flexible scopes (current page, filtered results, or entire collection)
- Keyboard shortcuts (Ctrl+F, Ctrl+K, Ctrl+E) for power users
- User preferences persistence per collection
- Virtual scrolling for large datasets (1000+ objects)
- See Data Explorer README for full details
Data Visualization
- Table view: Flattened, readable tables for nested JSON
- JSON view: Syntax-highlighted, collapsible JSON viewer
- Schema explorer: Interactive browsing of your Weaviate schema
- Real-time results: Live query execution with instant feedback
GraphQL Editor
- Monaco Editor with full GraphQL syntax support
- Auto-completion and context-aware suggestions
- Intelligent, schema-aware query generation that adapts to your collection schema
- Dynamic query templates with auto-populated properties and accurate vector dimensions
- Real-time validation and error highlighting
- Enhanced query templates for all major Weaviate operations with comprehensive error handling
- Reference field support and type-safe generation
Schema Management
- Browse collections and their properties
- View detailed schema information, data types, and relationships
- Support for cross-references and nested object structures with recursive navigation
- Visual property type icons (text, number, boolean, date, object, geo coordinates, phone, blob)
- Visual representation of your data model with hierarchical nested property display
- Create collections via three paths: From scratch, Copy from existing, or Import from JSON schema
Cluster Management
- Comprehensive Cluster Information Panel with real-time monitoring
- Auto-opens on connection by default (configurable)
- "Save and Connect" workflow for streamlined connection setup
- Cluster health and status monitoring
- Node information and statistics
Backup & Restore
- Create backups with real-time progress tracking
- Monitor backup status (in-progress, success, failed)
- Restore backups from any available backend
- Retry failed backups or cancel in-progress operations
- Multi-backend support: filesystem, S3, GCS, Azure
- Automatic detection of available backup modules
- Advanced configuration: include/exclude collections, custom paths
- Independent refresh controls for backups, collections, nodes, and metadata
Tree View
- Connection-level: Cluster information panel, backups, modules, collections overview
- Collection-level: Properties (with nested object support), vectors (with count), inverted index, generative config, statistics, sharding, replication, multi‑tenancy
Schema Analysis
- Enhanced schema viewer with overview, properties, raw JSON, API equivalents, and creation scripts
Developer Experience
- Hot reload for instant updates
- Full TypeScript support
- Modern, responsive UI
Query Templates
- Core: Basic Get, Vector Search, Semantic Search, Hybrid Search
- Advanced: Filter, Aggregation, Relationship, Sort, Explore
- Intelligent, schema-aware templates that dynamically adapt to your collection's actual schema
- Auto-populated properties based on data types (primitives, geo coordinates, references)
- Support for 15+ popular embedding models with automatic dimension detection
- Comprehensive error handling with graceful fallback system
- Visual decision tree and troubleshooting guide for 41 common mistakes
See the GraphQL Templates Guide for detailed usage, examples, and best practices: docs/GRAPHQL_TEMPLATES.md
Bulk Operations
- Delete All Collections (destructive) with double confirmation
Development & Contributing
We welcome contributions! Please see CONTRIBUTING.md for setup, development, and pull request guidelines.
Need a quick Weaviate instance for development or learning? Check out our local sandbox environment with pre-configured Docker setup and test data.
Architecture
Weaviate Studio uses a modular architecture with external React components for enhanced UI:
- Add Collection UI: Powered by
weaviate-add-collection(Live Demo) - a standalone React component for creating, cloning, and importing collections - Extension Core: TypeScript-based VS Code extension
- Webviews: React-based UIs with Monaco editor integration
For details on updating external dependencies, see the Working with Dependencies section in CONTRIBUTING.md.
Testing & Quality
- Comprehensive unit and integration tests with Jest
- Strict TypeScript and linting for code quality
- See TESTING_GUIDE.md for details
Support & License
- Issues: GitHub Issues
- Marketplace: VS Code Marketplace
- Open VSX: Open VSX Registry
- License: MIT (LICENSE)
Happy querying with Weaviate Studio! 🚀