roam-sdk 0.3.0

Roam Research SDK and terminal UI client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# roam-sdk

A Rust SDK and terminal UI for [Roam Research](https://roamresearch.com).

The `roam-sdk` crate provides two things in one package:

- **SDK** — a Rust client for the Roam Research API. Use it to build your own tools, scripts, or integrations.
- **TUI** — a terminal-based interface for navigating and editing your Roam graph.

## Quick links

| I want to... | Go to |
|---|---|
| Use the terminal app | [TUI Installation](tui/installation.md) |
| Configure the app | [Configuration](tui/configuration.md) |
| Learn keybindings | [Keybindings](tui/keybindings.md) |
| Use the Rust SDK | [SDK Getting Started](sdk/getting-started.md) |
| See API reference | [Client](sdk/client.md), [Types](sdk/types.md), [Queries](sdk/queries.md) |

## Architecture

```
roam-sdk (crate)
├── lib.rs          → SDK: RoamClient, types, queries, errors
└── main.rs         → TUI: terminal interface using the SDK
```

The TUI is built on [Ratatui](https://ratatui.rs) + [Tokio](https://tokio.rs) and uses the SDK internally. Both ship from the same crate — install the binary with `cargo install roam-sdk`, or add the library with `cargo add roam-sdk`.