Skip to main content
Use the Zenith CLI to take your app from a local project to a tested deployment and a marketplace submission.
Run these commands from your app’s root directory with Node.js 20.10 or later. zenith up builds your local project on Zenith and returns a temporary URL. When you are ready to submit a public GitHub commit for review, use zenith publish.

Start with the CLI

Install and get started

Sign in, prepare your project, and run local checks.

Test with zenith up

Launch a temporary deployment, inspect logs, and stop it when done.

Publish with zenith publish

Submit a pinned public commit and app listing for review.

Prepare your container

Adapt your Dockerfile or use existing public images.

Configure your app

Create zenith-compose.yml

Describe your app’s services, environment values, endpoints, and storage.

Compose reference

Check supported fields, defaults, and validation rules.

App integrations

SMTP email

Send app email with the supplied relay credentials.

Sign in with Zenith

Connect your app’s OpenID Connect client.

Public URLs and domains

Configure endpoints, base URLs, and allowed hosts.

Persistent storage and files

Mount app data and configure owner file access.

Forward authentication

Restrict an endpoint to the deployment owner’s Zenith account.

Editable configuration files

Let owners edit selected files without exposing the whole volume.