Update docs
This commit is contained in:
parent
2207b7d1ed
commit
455d90684b
3 changed files with 79 additions and 55 deletions
123
docs/cli.md
123
docs/cli.md
|
|
@ -2,22 +2,17 @@
|
||||||
|
|
||||||
The `haiku-rag` CLI provides complete document management functionality.
|
The `haiku-rag` CLI provides complete document management functionality.
|
||||||
|
|
||||||
## Shell Autocompletion
|
!!! note
|
||||||
|
All commands support:
|
||||||
|
|
||||||
Enable shell autocompletion for faster, error‑free usage.
|
- `--db` - Specify custom database path
|
||||||
|
- `-h` - Show help for specific command
|
||||||
|
|
||||||
- Temporary (current shell only):
|
Example:
|
||||||
```bash
|
```bash
|
||||||
eval "$(haiku-rag --show-completion)"
|
haiku-rag list --db /path/to/custom.db
|
||||||
```
|
haiku-rag add -h
|
||||||
- Permanent installation:
|
```
|
||||||
```bash
|
|
||||||
haiku-rag --install-completion
|
|
||||||
```
|
|
||||||
|
|
||||||
What’s completed:
|
|
||||||
- `get` and `delete`/`rm`: Document IDs from the selected database (respects `--db`).
|
|
||||||
- `add-src`: Local filesystem paths (URLs can still be typed manually).
|
|
||||||
|
|
||||||
## Document Management
|
## Document Management
|
||||||
|
|
||||||
|
|
@ -40,6 +35,10 @@ haiku-rag add-src /path/to/document.pdf
|
||||||
haiku-rag add-src https://example.com/article.html
|
haiku-rag add-src https://example.com/article.html
|
||||||
```
|
```
|
||||||
|
|
||||||
|
!!! note
|
||||||
|
As you add documents to `haiku.rag` the database keeps growing. By default, `lanceDB` supports versioning
|
||||||
|
of your data. You can optimize and compact the database by running the [vaccum](#vacuum-optimize-and-cleanup) command.
|
||||||
|
|
||||||
### Get Document
|
### Get Document
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -55,33 +54,8 @@ haiku-rag delete <TAB>
|
||||||
haiku-rag rm <TAB> # alias
|
haiku-rag rm <TAB> # alias
|
||||||
```
|
```
|
||||||
|
|
||||||
### Rebuild Database
|
|
||||||
|
|
||||||
Rebuild the database by deleting all chunks & embeddings and re-indexing all documents:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
haiku-rag rebuild
|
|
||||||
```
|
|
||||||
|
|
||||||
Use this when you want to change things like the embedding model or chunk size for example.
|
Use this when you want to change things like the embedding model or chunk size for example.
|
||||||
|
|
||||||
## Migration
|
|
||||||
|
|
||||||
### Migrate from SQLite to LanceDB
|
|
||||||
|
|
||||||
Migrate an existing SQLite database to LanceDB:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
haiku-rag migrate /path/to/old_database.sqlite
|
|
||||||
```
|
|
||||||
|
|
||||||
This will:
|
|
||||||
- Read all documents, chunks, embeddings, and settings from the SQLite database
|
|
||||||
- Create a new LanceDB database with the same data in the same directory
|
|
||||||
- Optimize the new database for best performance
|
|
||||||
|
|
||||||
The original SQLite database remains unchanged, so you can safely migrate without risk of data loss.
|
|
||||||
|
|
||||||
## Search
|
## Search
|
||||||
|
|
||||||
Basic search:
|
Basic search:
|
||||||
|
|
@ -108,13 +82,6 @@ haiku-rag ask "Who is the author of haiku.rag?" --cite
|
||||||
|
|
||||||
The QA agent will search your documents for relevant information and provide a comprehensive answer. With `--cite`, responses include citations showing which documents were used.
|
The QA agent will search your documents for relevant information and provide a comprehensive answer. With `--cite`, responses include citations showing which documents were used.
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
View current configuration settings:
|
|
||||||
```bash
|
|
||||||
haiku-rag settings
|
|
||||||
```
|
|
||||||
|
|
||||||
## Server
|
## Server
|
||||||
|
|
||||||
Start the MCP server:
|
Start the MCP server:
|
||||||
|
|
@ -129,14 +96,62 @@ haiku-rag serve --stdio
|
||||||
haiku-rag serve --sse
|
haiku-rag serve --sse
|
||||||
```
|
```
|
||||||
|
|
||||||
## Options
|
## Settings
|
||||||
|
|
||||||
All commands support:
|
View current configuration settings:
|
||||||
- `--db` - Specify custom database path
|
|
||||||
- `-h` - Show help for specific command
|
|
||||||
|
|
||||||
Example:
|
|
||||||
```bash
|
```bash
|
||||||
haiku-rag list --db /path/to/custom.db
|
haiku-rag settings
|
||||||
haiku-rag add -h
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Maintenance
|
||||||
|
|
||||||
|
### Vacuum (Optimize and Cleanup)
|
||||||
|
|
||||||
|
Reduce disk usage by optimizing and pruning old table versions across all tables:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
haiku-rag vacuum
|
||||||
|
```
|
||||||
|
|
||||||
|
### Rebuild Database
|
||||||
|
|
||||||
|
Rebuild the database by deleting all chunks & embeddings and re-indexing all documents. This is useful
|
||||||
|
when want to switch embeddings provider or model:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
haiku-rag rebuild
|
||||||
|
```
|
||||||
|
|
||||||
|
## Migration
|
||||||
|
|
||||||
|
### Migrate from SQLite to LanceDB
|
||||||
|
|
||||||
|
Migrate an existing SQLite database to LanceDB:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
haiku-rag migrate /path/to/old_database.sqlite
|
||||||
|
```
|
||||||
|
|
||||||
|
This will:
|
||||||
|
- Read all documents, chunks, embeddings, and settings from the SQLite database
|
||||||
|
- Create a new LanceDB database with the same data in the same directory
|
||||||
|
- Optimize the new database for best performance
|
||||||
|
|
||||||
|
The original SQLite database remains unchanged, so you can safely migrate without risk of data loss.
|
||||||
|
|
||||||
|
## Shell Autocompletion
|
||||||
|
|
||||||
|
Enable shell autocompletion for faster, error‑free usage.
|
||||||
|
|
||||||
|
- Temporary (current shell only):
|
||||||
|
```bash
|
||||||
|
eval "$(haiku-rag --show-completion)"
|
||||||
|
```
|
||||||
|
- Permanent installation:
|
||||||
|
```bash
|
||||||
|
haiku-rag --install-completion
|
||||||
|
```
|
||||||
|
|
||||||
|
What’s completed:
|
||||||
|
- `get` and `delete`/`rm`: Document IDs from the selected database (respects `--db`).
|
||||||
|
- `add-src`: Local filesystem paths (URLs can still be typed manually).
|
||||||
|
|
|
||||||
|
|
@ -52,7 +52,6 @@ haiku-rag migrate old_database.sqlite # Migrate from SQLite
|
||||||
- [Installation](installation.md) - Install haiku.rag with different providers
|
- [Installation](installation.md) - Install haiku.rag with different providers
|
||||||
- [Configuration](configuration.md) - Environment variables and settings
|
- [Configuration](configuration.md) - Environment variables and settings
|
||||||
- [CLI](cli.md) - Command line interface usage
|
- [CLI](cli.md) - Command line interface usage
|
||||||
- [Question Answering](qa.md) - QA agents and natural language queries
|
|
||||||
- [Server](server.md) - File monitoring and server mode
|
- [Server](server.md) - File monitoring and server mode
|
||||||
- [MCP](mcp.md) - Model Context Protocol integration
|
- [MCP](mcp.md) - Model Context Protocol integration
|
||||||
- [Python](python.md) - Python API reference
|
- [Python](python.md) - Python API reference
|
||||||
|
|
|
||||||
|
|
@ -99,6 +99,16 @@ async for doc_id in client.rebuild_database():
|
||||||
print(f"Processed document {doc_id}")
|
print(f"Processed document {doc_id}")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Maintenance
|
||||||
|
|
||||||
|
Run maintenance to optimize storage and prune old table versions:
|
||||||
|
|
||||||
|
```python
|
||||||
|
await client.vacuum()
|
||||||
|
```
|
||||||
|
|
||||||
|
This compacts tables and removes historical versions to keep disk usage in check. It’s safe to run anytime, for example after bulk imports or periodically in long‑running apps.
|
||||||
|
|
||||||
## Searching Documents
|
## Searching Documents
|
||||||
|
|
||||||
The search method performs native hybrid search (vector + full-text) using LanceDB with optional reranking for improved relevance:
|
The search method performs native hybrid search (vector + full-text) using LanceDB with optional reranking for improved relevance:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue