Complete documentation for the Weave CLI vector database management tool.
- User Guide - Complete feature documentation and usage guide
- Architecture - System design, agent layer, orchestration
- Roadmap - Version history, upcoming features, and release plan
- VDB Support Matrix - Quick reference feature comparison
- VDB Support - Detailed database comparison and analysis
User guides for specific features and workflows:
- Backup & Restore - Complete backup/restore guide with examples
- Weave Stack Quickstart - Local development stack setup
- AI Agents - Natural language query system with GPT-4o
- Batch Processing - Parallel document processing
- Vector DB Abstraction - Multi-database architecture
- BM25 Support by VDB - Full-text search across all databases
- OSS Embedding Tips - Free embedding providers
- Demos - Video tutorials and demonstrations
All VDB docs are under vdbs/:
| Database | Docs | Status |
|---|---|---|
| Weaviate | Setup, Integration Status | Stable |
| Qdrant | Setup | Stable |
| Milvus | Overview, Setup, Local, Cloud | Stable |
| Chroma | Setup | Stable |
| Supabase | Overview, Setup, Testing, TODO | Stable |
| MongoDB | Overview, Setup, Atlas | Stable |
| Neo4j | Overview, Setup, Aura | Stable |
| Pinecone | Setup | Beta |
| Elasticsearch | Overview, Setup, Local, Cloud | Beta |
| OpenSearch | Overview, AWS | Stable |
- Agent Management - Built-in and custom agents
- Weave Stack - Kubernetes stack deployment
- MCP AI Tools - MCP server integration
- Observability - Opik tracing and monitoring
- Shell Completion - Tab completion setup
- Timeout Configuration - Per-operation timeout tuning
- VDB Naming Convention - Collection naming rules
- Production Ready - Production readiness checklist
- Client0 Getting Started - Client0 onboarding
- Test Guide - Running tests
- Embedding Coverage - Multi-provider embedding test analysis
- Release Checklist - Release process
- v0.11.5 | v0.11.2 | v0.11.1 | v0.11.0
- v0.9.15 | v0.9.13 | v0.9.1
- v0.7.2 | v0.7.1 | v0.7.0
- Older releases: archive/releases/
- Opik Video/Blog Checklist - Opik collaboration (deadline: Mar 24-31)
- Presentation - Project presentation slides
- Blog Draft - Technical blog post draft
Active planning docs:
Historical documentation: archive/
docs/
├── README.md # This file - documentation index
├── USER_GUIDE.md # Main user guide
├── ARCHITECTURE.md # System architecture
├── VDB_SUPPORT.md # Detailed database comparison
├── VDB_SUPPORT_MATRIX.md # Quick reference matrix
├── WEAVE_STACK.md # Stack deployment
│
├── vdbs/ # All VDB-specific docs
│ ├── weaviate/
│ ├── qdrant/
│ ├── milvus/
│ ├── chroma/
│ ├── supabase/
│ ├── mongodb/
│ ├── neo4j/
│ ├── pinecone/
│ ├── elasticsearch/
│ └── opensearch/
│
├── guides/ # Feature guides
├── blogs/ # Blog/video collaboration
├── examples/ # Usage examples
├── integrations/ # CI/CD integrations
├── tests/ # Testing documentation
├── planning/ # Active planning
├── releases/ # Release notes
├── mcp/ # MCP integration
└── archive/ # Historical docs
- Issues: https://github.com/maximilien/weave-cli/issues
- Discussions: https://github.com/maximilien/weave-cli/discussions
- Main Repository: https://github.com/maximilien/weave-cli