App quickstart

App quickstart

This quickstart deploys an app to Lizard in a few minutes. Install Lizard CLI, sign in, start the 7-day Pro trial, then run lizard add -r owner/repo for a GitHub repository or lizard up for a local folder. Lizard builds the app on its servers, with no local Docker, and returns an HTTPS URL on onlizard.com. Lizard creates your account the first time you run lizard login.

1. Install the CLI

On macOS or Linux, run the install script:

curl -fsSL https://lizard.build/install.sh | bash

It puts the lizard binary in ~/.lizard/bin, adds that folder to your PATH in ~/.zshrc or ~/.bashrc, and links lizard into a folder that is already on your PATH, so it works in this terminal right away. The binary updates itself from then on, except in CI. If the script says lizard may not be found, open a new terminal. Check the version:

lizard --version

On Windows, run this in PowerShell:

irm https://lizard.build/api/cli/install.ps1 | iex

Or install from npm (needs Node.js 18+):

npm install -g @lizard-build/cli

Don’t use npx. Always use the globally installed lizard binary. Running npx @lizard-build/cli downloads a temporary copy whose version may differ from the platform. To upgrade an npm install later, run npm install -g @lizard-build/cli@latest.

Permission errors (EACCES)? Don’t use sudo. Use the install script above, which needs no admin rights, or point npm at a user-owned prefix:

mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc && source ~/.zshrc
npm install -g @lizard-build/cli

2. Log in

lizard login

This opens your browser to authenticate, then returns to your terminal after you confirm. In CI or other non-interactive environments, authenticate with a token instead:

export LIZARD_TOKEN=liz_xxx
# or
lizard login --token liz_xxx

API keys start with liz_. Create one with lizard keys create <name>. LIZARD_API_KEY works in place of LIZARD_TOKEN.

Check who you are at any time:

lizard whoami

3. Start the Pro trial

A new account has no plan, so creating anything returns HTTP 402 with a Checkout link. Start the 7-day Pro trial first:

lizard billing start

This opens Stripe Checkout, where you add a card. The trial includes $5 of usage, and nothing is charged until it ends. See Billing and lizard billing.

4. Deploy

Pick the path that matches where your code lives.

Option A — Deploy a GitHub repo (recommended)

If your code is on GitHub, create a service straight from the repo. Lizard clones it, auto-detects the stack, builds it, and returns a live URL:

lizard add -r your-org/your-app

Pushes to the tracked branch will auto-redeploy from then on. For private repos, connect the GitHub App first with lizard git:

lizard git connect

Option B — Deploy local code

From inside your project directory, upload and deploy the current folder (respects .gitignore):

lizard up

If the directory isn’t linked to a project yet, up will create or select one interactively. In CI, link explicitly first with lizard init --name my-project.

Either way, when the build finishes you’ll get a generated URL like https://your-app-x1y2z.onlizard.com.

Lizard detects most stacks on its own. For the exact build command, start command and port of your framework, see the guide for Next.js, React, Vue, Astro, SvelteKit, Node.js, Django, FastAPI, Rails or Go. An app with its own Dockerfile follows Deploy with a Dockerfile.

5. Watch it build and run

lizard ps          # services in the project, with status + URL
lizard logs        # last runtime log lines
lizard logs --build  # the most recent build's logs
lizard open        # open the project in the dashboard

lizard open shows the same project in the dashboard. For metrics, cost and deploy history, see Observability.

6. Add a database (optional)

Provision Managed Postgres and reference it from your service:

lizard add postgres
lizard secrets set DATABASE_URL='${{postgres.DATABASE_PRIVATE_URL}}' --service your-app
lizard redeploy --service your-app

Lizard resolves ${{postgres.DATABASE_PRIVATE_URL}} at deploy time so the service connects over the project’s private network. It matches the addon’s current name, so update the reference if you rename the addon. Credentials do not rotate on their own; a service picks up new values on its next deploy. See Managed Addons.

Next steps

Hosting costs

Pro costs $19 a month with $19 in monthly credits. Usage above that is pay as you go at the published rates. Pro starts with a 7-day trial and $5 in trial credits; you add a card to start it. See Billing and pricing, and check your limits before deploying.

IntroductionInstall Lizard Studio

Updated