SrcNexus CLI

Deploy projects and extensions to SrcNexus from the command line.

Install

npm install -g srcnexus

Requires Node.js 18 or later.

Quick Start

# Log in to your SrcNexus account
srcnexus login

# Deploy a project
cd my-project
srcnexus deploy

# Deploy an extension
srcnexus deploy --extension

Commands

login

Authenticate with your SrcNexus account.

srcnexus login

Interactive prompts will ask for your email/username and password. For CI environments, pass credentials directly:

srcnexus login --identifier [email protected] --password mypassword

| Option | Description | |---|---| | --identifier | Email or username | | --password | Account password | | --api-url | Custom API endpoint |

logout

Clear the local session.

srcnexus logout

whoami

Show the currently logged-in user.

srcnexus whoami

deploy

Deploy a project or extension from the current directory.

# Deploy as a project
srcnexus deploy

# Deploy as an extension
srcnexus deploy -e

# Deploy from a specific directory
srcnexus deploy --cwd /path/to/project

# Skip confirmation prompt
srcnexus deploy -y

| Option | Description | |---|---| | -e, --extension | Deploy as an extension | | --cwd <path> | Working directory (default: .) | | --name <name> | Project name (skips prompt) | | -y, --yes | Skip confirmation |

Your project is available at https://{username}.srcnexus.app/{project-name} after deployment.

ls

List your projects and extensions.

srcnexus ls              # List all
srcnexus ls --projects   # Projects only
srcnexus ls --ext        # Extensions only

rm <nameOrId>

Delete a project.

srcnexus rm my-project
srcnexus rm my-project -y   # Skip confirmation

download <nameOrId>

Download a project's files to your local machine.

srcnexus download my-project
srcnexus download my-project --cwd ./output

extension zip

Bundle an extension into a ZIP archive locally (without deploying).

srcnexus extension zip
srcnexus extension zip --cwd /path/to/extension -o bundle.zip
srcnexus extension zip -w   # Watch mode — rebuild on changes

| Option | Description | |---|---| | --cwd <path> | Extension directory (default: .) | | -o, --output <file> | Output ZIP filename | | -w, --watch | Watch for changes and rebuild |

Configuration

Credentials are stored in ~/.srcnexus/config.json. Tokens refresh automatically when expired.

Override the API endpoint with the SRCNEXUS_API_URL environment variable or a .env file in your project root.

File Handling

The CLI respects .gitignore rules and automatically excludes common directories like node_modules, .git, build, .dart_tool, and others. System files (.DS_Store, .env, *.log) are also ignored.

License

MIT