Skip to main content

Deployxa CLI Commands (@deployxa/cli)

The @deployxa/cli utility provides terminal commands for authentication, project management, deployments, domain configuration, and environment variables.

Authentication Commands​

deployxa login​

Authenticate your machine environment with Deployxa via OAuth.

deployxa login

deployxa logout​

Remove stored machine credentials from local system.

deployxa logout

deployxa whoami​

Display active user identity, organization, and subscription plan.

deployxa whoami

Project Management Commands​

deployxa init​

Interactively scaffold or provision a new project in the current directory.

deployxa init

Link local workspace to an existing Deployxa project.

deployxa link [--project <projectId>]

deployxa list / deployxa projects​

List all active projects within your organization.

deployxa list

Deployment Commands​

deployxa deploy​

Trigger a build and deploy the current project workspace to production.

deployxa deploy [path] [--prod] [--preview]

deployxa status​

Check current deployment status, uptime, and container state.

deployxa status [projectId]

deployxa logs​

Stream real-time build compilation or runtime stdout/stderr logs.

deployxa logs [projectId] [--tail <lines>] [--follow]

deployxa rollback​

Roll back a project to a previous successful deployment.

deployxa rollback <deploymentId>

Environment Variables Commands​

deployxa env list​

List environment variables configured for a project.

deployxa env list

deployxa env set​

Set or update an environment variable.

deployxa env set <KEY>=<VALUE>

deployxa env remove​

Delete an environment variable from a project.

deployxa env remove <KEY>

Domain Commands​

deployxa domain list​

List custom domains attached to a project.

deployxa domain list

deployxa domain add​

Attach a custom domain to a project.

deployxa domain add <domain-name>

Utility Commands​

deployxa version​

Display current CLI version.

deployxa --version