Skip to main content

​
Prerequisites

  • macOS or Linux with Git installed.
  • Node.js 22.12+ and pnpm (the major app commands enforce these versions automatically).
If you plan to connect databases or APIs, make sure you already have those resources registered in https://app.major.build so you can attach them during app creation.

​
Step 1 — Install the CLI

curl -fsSL https://install.major.build | bash
Confirm with major --version.

​
Step 2 — Authenticate and set your org

major user login
major user whoami verifies your session and shows the org that scoped env variables and deployments will use.

​
Step 3 — Create or clone an application

Pick whichever best matches your workflow: 
major app create
  • Choose a template (Vite is the default).
  • Major provisions a GitHub repo, wires up the template, and invites you as a collaborator.
  • Select the resources (databases, APIs) the app should reach. We store the mapping for deployments and local dev.
major app clone
  • Choose from your organization’s applications.
  • We clone (or pull) the repo, invite you if needed, and regenerate .env + your resource clients so that you’re ready to run.

​
Step 4 — Run locally

major app start
This command:
  • Calls the Major API to mint a new JWT and writes every required variable into .env.
  • Runs pnpm install to keep dependencies in sync with the template baseline.
  • Starts pnpm dev so your local server proxies requests through the Major control plane.
You can view or edit the app from the UI anytime with: 
major app editor

​
Step 5 — Configure Resources

Configure the resources you want your app to interact with. 
major resource create
We highly recommend reading Resource connections to understand how resource connections work.

​
Step 6 — Deploy

major app deploy
Major will:
  1. Prompt for a commit message if it sees unstaged work, then stage/commit/push for you.
  2. Create a new version through the API and stream deployment status (bundling → building → deploying).
  3. Print the production URL when the status flips to DEPLOYED.

​
Where to go next

App lifecycle workflow

Follow the recommended loop from template to deployment.

Full command reference

Dive deep into every command, its flags, and side effects.