mirror of
https://github.com/aljazceru/turso.git
synced 2026-02-21 07:55:18 +01:00
fbc3d0dbc3
In the hopes of doing a good job at teaching people what Turso can do, I am adding built-in manual pages. When the CLI starts, it picks a feature at random, and tells the user that the feature exists: ``` Turso v0.2.0-pre.8 Enter ".help" for usage hints. Did you know that Turso supports Change Data Capture? Type .manual cdc to learn more. This software is ALPHA, only use for development, testing, and experimentation. Connected to a transient in-memory database. Use ".open FILENAME" to reopen on a persistent database ``` There is a lot we can do to make this feature world class: - we can automatically compile examples during compile time like rust-doc, to make sure examples used in the manuals always work - we can implement scrolling and navigation - we can document a lot more features But for now, this is a start!
53 lines
1.2 KiB
Markdown
53 lines
1.2 KiB
Markdown
# Turso Manual Pages
|
|
|
|
Welcome to the Turso manual pages. These pages provide detailed documentation for various features and capabilities.
|
|
|
|
## Available Manuals
|
|
|
|
### cdc - Change Data Capture
|
|
Track and capture all data changes made to your database tables for replication, syncing, and reactive applications.
|
|
|
|
```
|
|
.manual cdc
|
|
```
|
|
|
|
### encryption - At-Rest Database Encryption
|
|
Protect your database files with transparent encryption using AES-GCM or high-performance AEGIS ciphers.
|
|
|
|
```
|
|
.manual encryption
|
|
```
|
|
|
|
### mcp - Model Context Protocol
|
|
Learn about Turso's built-in MCP server that enables AI assistants and other tools to interact with your databases.
|
|
|
|
```
|
|
.manual mcp
|
|
```
|
|
|
|
### vector - Vector Search
|
|
Build similarity search and semantic search applications using vector embeddings and distance functions.
|
|
|
|
```
|
|
.manual vector
|
|
```
|
|
|
|
## Usage
|
|
|
|
To view a manual page, use the `.manual` or `.man` command:
|
|
|
|
```
|
|
.manual <page> # Full command
|
|
.man <page> # Short alias
|
|
```
|
|
|
|
### Examples
|
|
|
|
```
|
|
.manual mcp # View the MCP server documentation
|
|
.man mcp # Same as above, using the alias
|
|
```
|
|
|
|
## Adding More Manuals
|
|
|
|
Additional manual pages will be added for other features as they become available. |