Developers

DashNex CLI

Command-line interface for developers to integrate, customize, and deploy anything on your WebApp directly from your IDE.

Installation

Install the DashNex CLI globally using npm:

$
npm i -g dashnex

Verify your installation by checking the version:

dashnex version

Getting Started

Here's the typical workflow to get up and running:

# Authenticate with your DashNex account
dashnex login

# Pull an existing app to a local folder
dashnex app pull my-app

# Or create a new app
dashnex app create

# Start the local development server
dashnex dev

# Push and deploy your app
dashnex app push --deploy

Account

dashnex login

Authenticate with your DashNex account. When run without options, the CLI will interactively prompt for your credentials. You can also pass them directly for use in scripts or CI/CD.

OptionDescription
--emailAccount email address
--passwordAccount password
--codeTwo-factor authentication code
--businessBusiness ID to log in to
$
dashnex login --email user@example.com --password pswd --code 123456 --business 12345

Credentials are stored locally in .dashnex/settings.json. If you run this command in your home folder, the credentials will be valid for all subfolders.

dashnex logout

Log out of the current session and clear stored credentials.

dashnex whoami

Display the currently authenticated user and active business.

dashnex version

Show the installed CLI version.

App Management

dashnex app create

Create a new app. The CLI will guide you through configuring the app interactively, or you can pass options directly.

OptionDescription
--subdomainSet a custom subdomain for the app

dashnex app pull [folder]

Pull an existing app from the server to a local folder. If no folder is specified, the CLI will prompt for one — the current directory is used by default.

OptionDescription
-y, --yesSkip confirmation prompts

dashnex app push

Push local changes to the server. Performs code checks before pushing (runs dashnex check first).

OptionDescription
--deployDeploy immediately after pushing
--no-deploySkip deployment (by default you will be asked if you want to deploy immediately)
--no-checkSkip TypeScript type checking before push

dashnex app deploy

Deploy the app to production. Shows real-time progress so you can follow the deployment as it happens.

dashnex app status

Show the current app deployment status and its live URL.

dashnex app delete

Delete the app from the server. This action is irreversible.

OptionDescription
-y, --yesSkip confirmation prompts

Development

dashnex install

Install project dependencies. Automatically detects whether to use pnpm or npm based on the lock file present in the project.

dashnex build

Discover installed @dashnex modules and generate the module registry, CSS imports, and worker configuration.

dashnex db create

Create the database for the project.

dashnex db migrate

Run all pending database migrations from installed @dashnex modules.

dashnex dev

Start the local development server for your app. This watches for file changes and provides hot reload during development.

OptionDescription
--httpsEnable HTTPS for the local dev server

dashnex check

Run TypeScript type checking on the project.

CI/CD Usage

Use the --ci flag in CI/CD environments to disable interactive spinners and prompts:

dashnex app push --deploy --ci

What You Can Build

With the DashNex CLI, you can build and deploy custom designs, integrations, and full-stack applications on top of your WebApp. The platform provides the foundation — authentication, payments, email, CRM, and more — while you focus on your unique product offering.

Developers can build entire SaaS products on top of the WebApp and combine the functionality of powerful modules like instraCHAT or UltraX Agent with their own custom product using Reseller Modules.