Skip to content

Installation

  • Zig 0.16.0 or later — Install Zig
  • Git — for fetching dependencies via build.zig.zon

The zzz CLI provides project scaffolding, code generation, a dev server, and database migrations.

Terminal window
curl -fsSL https://zzz.seemsindie.com/install.sh | sh

Install a specific version:

Terminal window
ZZZ_VERSION=v0.1.0 curl -fsSL https://zzz.seemsindie.com/install.sh | sh

Verify the installation:

Terminal window
zzz version
  1. Scaffold the project

    Terminal window
    zzz new my_app

    This creates a full project structure:

    my_app/
    build.zig
    build.zig.zon
    .gitignore
    src/
    main.zig
    controllers/
    templates/
    public/
    css/style.css
    js/app.js
  2. Build and run

    Terminal window
    cd my_app
    zig build run

    Your server is now running at http://127.0.0.1:4000.

  3. Start the dev server (with auto-reload)

    Terminal window
    zzz server

If you already have a Zig project and want to add zzz as a dependency:

  1. Add the dependency to your build.zig.zon:
.dependencies = .{
.zzz = .{
.url = "https://github.com/seemsindie/zzz.zig/archive/refs/tags/v0.1.0.tar.gz",
.hash = "...", // zig build will tell you the expected hash
},
},
  1. Wire it up in build.zig:
const zzz_dep = b.dependency("zzz", .{
.target = target,
.optimize = optimize,
});
exe.root_module.addImport("zzz", zzz_dep.module("zzz"));
  1. Import and use:
const zzz = @import("zzz");
PackageWhat it addsHow to enable
zzz_dbDatabase (SQLite & PostgreSQL)Add zzz_db dependency
zzz_jobsBackground job processingAdd zzz_jobs dependency
zzz_mailerEmail sendingAdd zzz_mailer dependency
zzz_templateTemplate engineAdd zzz_template dependency