Skip to main content
This guide walks you through building and deploying an internal tool using the Major CLI.

​
Prerequisites

  • macOS or Linux with Git installed
  • Node.js 22.12+ and pnpm

​
Step 1 — Install the CLI

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

​
Step 2 — Authenticate

major user login
This opens the login page in your browser. Sign up or sign in, then select your organization.
Run major user whoami anytime to check your current session and organization.

​
Step 3 — Create an app

major demo create
This creates a demo app with a pre-configured database and sample dashboard. Alternatively, you can also: 
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 connectors (databases, APIs) the app should reach.
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:
  • Mints a new JWT and writes environment variables to .env
  • Runs pnpm install to sync dependencies
  • Starts pnpm dev so your local server connects to your connectors through Major
Your app is now running locally with full access to connected connectors.

​
Step 5 — Configure connectors

Configure the connectors you want your app to interact with. 
major resource manage
Read Connectors to understand how resource connections work.

​
Step 6 — Deploy

major app deploy
Major will:
  1. Prompt for a commit message if there are unstaged changes
  2. Stage, commit, and push to GitHub
  3. Build and deploy your app
  4. Print the production URL when complete

​
Next steps

Core Concepts

Learn about Apps, Connectors, and RBAC.

CLI Reference

Explore all available CLI commands.

Web Dashboard

Try building in the browser instead.

Connectors

Learn how to query databases and APIs from your code.