Two ways to use it
AI Guide
You do not write code. Say what you want in plain language; the agent installs the tools, creates the project and runs every command. Each page is a prompt to paste and a result to check.
Start with the AI Guide →Guide
You run the commands yourself. Clear numbered steps take you from installing the CLI to developing and deploying each platform, with the full command reference at the end.
Start with the Guide →New to development? Take the AI Guide — no Java, Vue, Docker or Rust experience needed. You follow prompts, not code.
Quick start
Node 22.12.0 or newer and pnpm are the only prerequisites. Five commands take you from nothing to a running project.
Install the tool
Get pnpm, then install the mars CLI once, globally.
Create your project
mars create asks which platforms you need and copies only those.
Move into it
Every later command runs from inside the new project folder.
Install what it needs
One pnpm install sets up the whole workspace at once.
Start developing
mars dev starts every enabled platform; native targets bring their own toolchains when enabled.
Need the full matrix of platforms, Docker variants and CLI flags? Continue with Environment Setup.
pnpm add -g @marsquakes/cli
mars create my-app
cd my-app
pnpm install
mars dev
One scaffold, every target
Every platform mars can generate, in the one monorepo. Tick the targets you need; mars create copies only those and mars init derives the toolchain each one needs.
API
JeecgBoot / Spring BootReadyWeb Admin
Vue 3 + ViteReadyDesktop
Tauri + React + RustReadyAndroid
Kotlin + Jetpack ComposeScaffold onlyiOS
Swift + SwiftUIScaffold onlyWeb
Scaffold onlyWindows
Scaffold onlyLinux
Scaffold onlymacOS
Scaffold only
"Ready" builds and runs out of the box today; "Scaffold only" reserves the structure for you. See the full platform matrix.