Getting Started
This guide takes you through the public first-contact path: install Mesh, run hello-world, then choose the starter that matches what you want to evaluate next.
Installation
Use the documented installer scripts to install both meshc and meshpkg. The staged release proof covers these installer targets:
- macOS
x86_64andarm64 - Linux
x86_64andarm64(GNU libc) - Windows
x86_64
macOS and Linux:
curl -sSf https://meshlang.dev/install.sh | shWindows x86_64 (PowerShell):
irm https://meshlang.dev/install.ps1 | iexThe installers place both binaries in ~/.mesh/bin on Unix-like systems and ~\.mesh\bin on Windows.
Verify the install
After installing, verify both binaries are available:
meshc --version
meshpkg --versionYou should see the Mesh version number printed for each command.
Alternative: Build from source
If you are contributing to Mesh or targeting an environment outside the public installer coverage, build from source instead. Treat this as an alternative workflow, not the primary public install path:
git clone https://github.com/snowdamiz/mesh-lang.git
cd mesh-lang
cargo install --path compiler/meshc
cargo install --path compiler/meshpkgHello World
Create a new Mesh project:
meshc init hello
cd helloOpen main.mpl and replace its contents with:
fn main() do
println("Hello, World!")
endCompile and run it:
meshc build .
./helloYou should see Hello, World! printed to the terminal.
main.mpl remains the default executable entrypoint. If you need a different startup file later, use the optional [package].entrypoint = "lib/start.mpl" setting in mesh.toml.
Choose your next starter
Once hello-world runs, pick the starter that matches your next job.
meshc init --clustered hello_cluster— the minimal clustered starter. It keeps the public clustered-app contract small:work.mpldeclares@cluster,main.mplboots throughNode.start_from_env(), and runtime inspection stays on Mesh-ownedmeshc cluster status|continuity|diagnosticscommands.meshc init --template todo-api --db sqlite todo_api— the honest local starter. It is a single-node SQLite Todo API with actor-backed write rate limiting, generated package tests, and no clustered placement or operator claims.meshc init --template todo-api --db postgres shared_todo— the serious shared/deployable PostgreSQL starter. It keeps clustered work source-first, uses migrations plus a realDATABASE_URL, and dogfoodsHTTP.clustered(1, ...)only on the shared read routes while local health and mutating routes stay local.
What's Next?
The proof pages stay public, but they are follow-on reading after the starter chooser instead of the first stop.
- Clustered Example -- the scaffold-first clustered tutorial using
meshc init --clustered - Production Backend Proof -- the deeper backend proof surface once the starter docs stop being enough, paired with
reference-backend/README.md - Language Basics -- variables, types, functions, pattern matching, control flow, and more
- Type System -- structs, sum types, generics, and type inference
- Concurrency -- actors, message passing, supervision, and services