> For the complete documentation index, see [llms.txt](https://roam-tui.avelino.run/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://roam-tui.avelino.run/tui/installation.md).

# Installation

## From crates.io

```bash
cargo install roam-sdk
```

This installs the `roam` binary.

## From source

```bash
git clone https://github.com/avelino/roam-tui.git
cd roam-tui
cargo install --path .
```

## From GitHub releases

Pre-built binaries are available for every release:

| Platform                    | Target                            |
| --------------------------- | --------------------------------- |
| Linux x86\_64               | `roam-x86_64-unknown-linux-gnu`   |
| Linux ARM64                 | `roam-aarch64-unknown-linux-gnu`  |
| macOS x86\_64               | `roam-x86_64-apple-darwin`        |
| macOS ARM64 (Apple Silicon) | `roam-aarch64-apple-darwin`       |
| Windows x86\_64             | `roam-x86_64-pc-windows-msvc.exe` |

Download from [Releases](https://github.com/avelino/roam-tui/releases), make executable (`chmod +x roam-*`), and move to your PATH.

## First run

On first run, `roam` creates a default config file and tells you where it is:

```
Created default config at: ~/.config/roam-tui/config.toml
Please edit it with your Roam graph name and API token, then run again.
```

Edit the file with your graph name and API token, then run `roam` again.

## Getting an API token

1. Open your Roam graph in the browser
2. Go to **Settings** → **Graph** → **API tokens**
3. Create a new token with read/write permissions
4. Copy the token into your config file or set the `ROAM_GRAPH_API__TOKEN` environment variable


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://roam-tui.avelino.run/tui/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.