speed on speed documentation

Quickstart

Mon, 01 Jan 0001 00:00:00 +0000

Quickstart

Nothing is published yet. speed’s first tagged release lands at milestone M4 (see Status); until then there is no go get github.com/vislake/speed/... and no npm install @speed/... from a registry. The path below — a local checkout plus go run — is the real, current way to try speed, not a simplification of a published flow.

1. Clone the repository

git clone https://github.com/vislake/speed
cd speed

The repository root is a Go workspace (go.work), not a Go module — see the note on running Go commands below.

Modules

Mon, 01 Jan 0001 00:00:00 +0000

Module index

speed ships as independently released Go modules and npm packages, not an application. A consumer project imports the ones it needs. Every row below links to that module’s own AGENTS.md or README.md in the repository — this site keeps no copy of module documentation, so the linked file is always the current one.

This page lists what exists, not what is proven equally solid. Read-for-yourself is still the rule: the root CLAUDE.md’s Repository Status section (see For AI Agents) is the single source of truth for which modules genuinely pass go build / go vet / golangci-lint / go test -race in CI today — all 21, go/admin included, per fast-check.yml’s own go-modules matrix.

For AI Agents

Mon, 01 Jan 0001 00:00:00 +0000

For AI Agents

If you are a coding agent helping someone integrate speed, or being pointed at this site as context, this page is for you. speed’s own documentation standard treats agents and humans as first-class readers equally (see docs/internal/13, Chinese-language design rationale) — this page and llms.txt at the site root are this site’s own answer to that.

Read this first, in this order

Root AGENTS.md — orientation for any AI coding tool: top-level shape, the module dependency direction, the rules that will burn you fastest, and where everything else lives. Written to be read start to finish in a couple of minutes.
The target module’s own AGENTS.md (go/<name>/AGENTS.md or web/packages/<name>/AGENTS.md) — module-specific discipline, file layout, known limitations, testing setup. See the module index for the full list with direct links.
Root CLAUDE.md’s Repository Status section — see below, this is the one you must not let go stale in your own head.

The single source of truth for “is this actually implemented”

Root CLAUDE.md’s Repository Status section is the single, authoritative, current answer to “what genuinely runs and passes in CI today.” It names, per module, exactly what is implemented, what CI workflow proves it (and on what trigger — every PR, a full-ci-labeled PR, a manual dispatch), and what is still a placeholder stub. This static site cannot update itself as fast as that section changes — do not treat anything on this site as a substitute for reading it, and do not trust a status claim (including this site’s own Status page) that you have not cross-checked against it or against the repository itself.

About

Mon, 01 Jan 0001 00:00:00 +0000

About speed

speed is the shared foundation of a multi-tenant SaaS product family. It is not an application: it is a set of independently released Go modules and npm packages, versioned in lockstep, that a business project pulls in and compiles into a single binary. Modules call each other in-process — there is no service discovery and no Kubernetes-shaped infrastructure.

The shape

Aspect	Design
Dependencies	Strictly bottom-up: the foundation modules (`pkgcore`, `dbkit`, `observability`, `ratelimit`, `tenancy`) underpin everything above them.
Deployment mode and composition	Two orthogonal axes. Every infrastructure dependency is an interface with several implementations (an in-process one, plus PostgreSQL, Redis, S3 and other backed ones). The deployment mode does not select an implementation, it only constrains one: each implementation declares its capabilities, and assembly fails when the composition cannot run in the declared mode. A single-process deployment may talk to real external services. Business code never branches on the mode.
Multi-tenancy	A shared database with `tenant_id` isolation, guarded by a GORM plugin, a mandatory generic repository base, and PostgreSQL row-level security in the distributed mode.
Versioning	Lockstep: all modules and packages share one version and release together; only same-version combinations are supported.

How documentation is distributed

Each module carries its own AGENTS.md inside the module — a quick orientation for an AI coding tool: responsibility boundary, public API, typical usage, and explicit dos-and-don’ts — plus a plain README.md, so documentation ships with the code and stays current with the version a consumer actually pulls. (A per-module docs/usage.md is the longer-term plan recorded in docs/internal/13; as of this writing exactly one module, go/notification, has created one — go/notification/docs/usage.md, written as a template for the rest, its own header says as much — while every other Go module and every npm package still relies on just its AGENTS.md plus its README.md.) This site is the central reference across modules — see Modules for the full index — planned to be versioned per release, with the module-level docs pointing at it for the overview.

Status

Mon, 01 Jan 0001 00:00:00 +0000

Implementation status

The authoritative, always-current statement lives in the repository root CLAUDE.md’s Repository Status section, which this page deliberately does not reproduce — a duplicated per-module census would rot the moment the next module round lands. What follows is a coarse snapshot verified against the live repository at the time this page was last written; treat it as an orientation, not a source.

Naming the status by milestone number stopped being the useful framing here — implementation moved well past the original M0 milestone this site once tracked. Most of the planned module graph is landed; the roadmap’s milestone numbers (docs/internal/15-roadmap.md) still record which round a module was originally scheduled for, but several modules shipped well ahead of that window.