gpui-scaffold

GPUI Project Scaffolding

Scaffold a new GPUI application with modern project structure, best practices, and example components.

Arguments

• $1: Project name (required) - Name for the new GPUI project (hyphen-case recommended)
• $2: Template type (optional) - Either "app" (default) or "library"

Workflow

1. Validate Project Name

• Check that project name is provided
• Validate naming convention (lowercase, hyphens, no spaces)
• Check that directory doesn't already exist
• Confirm project creation with user if needed

2. Create Directory Structure

Create the following structure:

project-name/
├── Cargo.toml
├── .gitignore
├── README.md
├── src/
│   ├── main.rs (for app) or lib.rs (for library)
│   ├── app.rs
│   ├── ui/
│   │   ├── mod.rs
│   │   ├── views/
│   │   │   ├── mod.rs
│   │   │   └── main_view.rs
│   │   ├── components/
│   │   │   ├── mod.rs
│   │   │   ├── button.rs
│   │   │   └── input.rs
│   │   └── theme.rs
│   ├── models/
│   │   ├── mod.rs
│   │   └── app_state.rs
│   └── utils/
│       └── mod.rs
├── examples/
│   └── basic.rs
└── tests/
    └── integration_test.rs

3. Generate Cargo.toml

Create Cargo.toml with:

[package]
name = "project-name"
version = "0.1.0"
edition = "2021"

[dependencies]
gpui = { git = "https://github.com/zed-industries/zed" }
anyhow = "1.0"
log = "0.4"
env_logger = "0.11"

[dev-dependencies]
criterion = "0.5"

[[bench]]
name = "rendering"
harness = false

4. Create Main Entry Point

For applications (main.rs):

use gpui::*;
mod app;
mod ui;
mod models;
mod utils;

use app::App;

fn main() {
    env_logger::init();

    App::new("com.example.project-name", |cx| {
        let app = cx.new_model(|cx| app::AppModel::new(cx));
        let window = cx.open_window(
            WindowOptions {
                bounds: WindowBounds::Fixed(Bounds {
                    origin: point(px(100.0), px(100.0)),
                    size: size(px(1200.0), px(800.0)),
                }),
                ..Default::default()
            },
            |cx| cx.new_view(|cx| ui::views::MainView::new(app.clone(), cx)),
        );

        window.unwrap()
    })
    .run();
}