---
title: Rust Quickstart
sidebar_label: Rust
slug: /quickstarts/rust
hide_table_of_contents: true
---

import { InstallCardLink } from "@site/src/components/InstallCardLink";
import { StepByStep, Step, StepText, StepCode } from "@site/src/components/Steps";


Get a SpacetimeDB Rust app running in under 5 minutes.

## Prerequisites

- [Rust](https://www.rust-lang.org/tools/install) installed
- [SpacetimeDB CLI](https://spacetimedb.com/install) installed

<InstallCardLink />

---

<StepByStep>
  <Step title="Create your project">
    <StepText>
      Run the `spacetime dev` command to create a new project with a Rust SpacetimeDB module.

      This will start the local SpacetimeDB server, compile and publish your module, and generate Rust client bindings.
    </StepText>
    <StepCode>
```bash
spacetime dev --template basic-rs my-spacetime-app
```
    </StepCode>
  </Step>

  <Step title="Explore the project structure">
    <StepText>
      Your project contains both server and client code.

      Edit `spacetimedb/src/lib.rs` to add tables and reducers. Use the generated bindings in `client/src/module_bindings/` to build your client.
    </StepText>
    <StepCode>
```
my-spacetime-app/
├── spacetimedb/          # Your SpacetimeDB module
│   ├── Cargo.toml
│   └── src/
│       └── lib.rs        # Server-side logic
├── client/               # Client application
│   ├── Cargo.toml
│   └── src/
│       ├── main.rs
│       └── module_bindings/  # Auto-generated types
└── README.md
```
    </StepCode>
  </Step>

  <Step title="Understand tables and reducers">
    <StepText>
      Open `spacetimedb/src/lib.rs` to see the module code. The template includes a `Person` table and two reducers: `add` to insert a person, and `say_hello` to greet everyone.

      Tables store your data. Reducers are functions that modify data — they're the only way to write to the database.
    </StepText>
    <StepCode>
```rust
use spacetimedb::{ReducerContext, Table};

#[spacetimedb::table(name = person, public)]
pub struct Person {
    name: String,
}

#[spacetimedb::reducer]
pub fn add(ctx: &ReducerContext, name: String) {
    ctx.db.person().insert(Person { name });
}

#[spacetimedb::reducer]
pub fn say_hello(ctx: &ReducerContext) {
    for person in ctx.db.person().iter() {
        log::info!("Hello, {}!", person.name);
    }
    log::info!("Hello, World!");
}
```
    </StepCode>
  </Step>

  <Step title="Test with the CLI">
    <StepText>
      Use the SpacetimeDB CLI to call reducers and query your data directly.
    </StepText>
    <StepCode>
```bash
# Call the add reducer to insert a person
spacetime call my-spacetime-app add Alice

# Query the person table
spacetime sql my-spacetime-app "SELECT * FROM person"
 name
---------
 "Alice"

# Call say_hello to greet everyone
spacetime call my-spacetime-app say_hello

# View the module logs
spacetime logs my-spacetime-app
2025-01-13T12:00:00.000000Z  INFO: Hello, Alice!
2025-01-13T12:00:00.000000Z  INFO: Hello, World!
```
    </StepCode>
  </Step>
</StepByStep>

## Next steps

- See the [Chat App Tutorial](../00300-tutorials/00100-chat-app.md) for a complete example
- Read the [Rust SDK Reference](../../00200-core-concepts/00600-client-sdk-languages/00500-rust-reference.md) for detailed API docs
