Getting started

Getting started

There is no install step to run yet: Mesh has no release. This page is therefore a reading path, plus a short section on what does work today.

Where to start

Follow the numbered reading path in the Docs overview. After this page, it goes from Installation to the todo example, Usage and Project structure, then the action, configuration, command-line and resource references. Keeping the list in one place avoids competing routes through the same material.

The shape in one paragraph

One .mx file declares a resource: its attributes, its relationships, its actions and the rules around them. mesh build reads those files with MX, the parser, and writes ordinary TypeScript: a type per resource, a function per action with the whole lifecycle written out, an input validator per action, and the database schema. You import those functions and call them. The call takes the input and a scope — who is calling — as a plain argument. That is the whole interface: no server, no routes, no generated client, no RPC.

Trying Mesh today

Nothing is installed, so the only way to try Mesh is to work on it. The parts that exist are the resource vocabulary, enforced as tag contracts when MX parses a .mx file, and the plain-data types and registries for the resource model. The builder that turns the tree into that model is not implemented yet.

The contracts live in the packages/compiler workspace package. They depend on MX, a separate project, through link: entries in packages/compiler/package.json. Register your MX checkout once by running bun link inside it. After that a plain bun install at the repository root resolves the link: entries, so there is no per-clone link step. Do not run bun link @mxlang/data @mxlang/core at the repository root: bun link <package> writes a link: dependency into the package.json of the directory it runs in, which would add MX to the root package.

Then install and verify from the repository root:

bun install
bun run verify      # tests, type check, docs build and link check
bun run test        # tests only
bun run typecheck   # type check only

The examples/blog directory holds the fixture resource post.mx and is where the first generated handlers will be called. To build this documentation site, read Contributing to these docs.

Next

• Docs overview — what Mesh is and how to read these pages.
• Roadmap — the order the code will be built in.