Docs
DeployxaDocs Portal
CLI v1.0.4
Getting Started Guide
Getting started

From a repository to a live HTTPS URL

Create an account, deploy from Git or the CLI, then add a domain and environment variables. Most apps are live in a few minutes.

1. Create an account

Sign up from the dashboard. The Free plan has no time limit and needs no credit card: 3 projects, shared CPU with 512 MB RAM, and a free *.deployxa.online address. Compare the other plans on the pricing page.

2. Choose how to ship code

SourceBest forHow
GitHubApps that live in a GitHub repoDashboard → New project → GitHub. Connect your account (or use a personal access token) and pick a repository and branch.
Git URLRepos on another hostDashboard → New project → Git URL. Paste the clone URL and default branch.
Archive (.zip)A folder without GitDashboard → New project → Archive, then select a .zip.
CLIDeploying from your terminal or CIdeployxa deploy uploads the current folder.

Option A: Deploy from the dashboard

  1. 1
    Pick the source

    Open New project and choose GitHub, Git URL or Archive.

  2. 2
    Check the framework

    Deployxa detects the framework and fills in the build command and output directory. Open the advanced settings to change the root directory (for monorepos), build command or output directory. Projects with a Dockerfile build from it and skip those fields.

  3. 3
    Add environment variables

    Add keys one by one or paste a .env file in bulk mode. You can change them later.

  4. 4
    Deploy

    Follow the build log. When it finishes you get a live HTTPS URL.

Option B: Deploy with the CLI

shell
$ npm install -g @deployxa/cli
$ deployxa login
$ cd my-app
$ deployxa deploy

In a folder that is not linked yet, deployxa deploy creates a project named after the folder, links it, uploads the source and follows the build until it succeeds. Requires Node.js 18+.

The CLI uploads the whole folder: CLI 1.0.4 has no ignore file. Deploy from a clean folder and keep secrets out of files. See Deployments.

3. Check the deployment

shell
$ deployxa status        # status and URL
$ deployxa logs --live   # follow build and runtime output
$ deployxa open          # open the live URL

Builds go through Queued, Building and Deploying. If one fails, read the log first; the troubleshooting guide covers the usual causes.

4. Add environment variables

shell
$ deployxa env set DATABASE_URL "postgres://user:pass@host:5432/app"
$ deployxa env push      # upload every line of .env.local (or .env)
$ deployxa redeploy      # start a new deployment with the new values

Values are stored encrypted. More in Environment variables.

5. Add a custom domain

shell
$ deployxa domains add app.example.com

Create an A record (apex domain) or CNAME (subdomain) with the value shown on the dashboard's Domains page, then retry verification there. HTTPS certificates from Let's Encrypt are issued and renewed automatically on every plan. Details in Custom domains.

6. Roll back if something breaks

shell
$ deployxa rollback previous

Rollback re-activates an earlier successful build without rebuilding. In the dashboard, a release still on warm standby can be swapped back instantly from its deployment row.

Next steps