Only-Once CLI

Command-line tool for deploying frontend code to the Only-Once deployment service.

Installation

npm install -g onlyonce-cli

Or use with npx (no installation needed):

npx onlyonce-cli deploy

Usage

Deploy with Auto-Detection

When no directory is provided, the CLI runs your project's build script and auto-detects common output directories (build, dist, out, .next, public):

npx onlyonce-cli deploy

Deploy from Specific Directory

npx onlyonce-cli deploy ./build
npx onlyonce-cli deploy ./dist
npx onlyonce-cli deploy /path/to/your/build

Other Commands

npx onlyonce-cli device-login   # Create or refresh a device session
npx onlyonce-cli --version      # Show version
npx onlyonce-cli --help         # Show help

Configuration

Set the Only-Once API URL via environment variable:

export ONLY_ONCE_API_URL=http://localhost:3000
npx onlyonce-cli deploy

Or create a .env file:

ONLY_ONCE_API_URL=http://localhost:3000

Default API URL: http://localhost:3000

Device Session Storage

The CLI stores the device token and ID in ~/.onlyonce/config.json. Running npx onlyonce device-login refreshes this token and prepares the CLI for future deployments.

How It Works

1. Build: Runs your project's build script if a directory is not provided
2. Auto-Detection: Finds common build directories (build, dist, out, .next, public)
3. Zip: Archives the build output for upload
4. Deployment: Uploads the zip to the Only-Once API
5. Result: Returns the live CDN URL where your app is deployed

Examples

React App

npm run build
npx onlyonce-cli deploy ./build

Next.js App

npm run build
npx onlyonce-cli deploy ./out

Vite App

npm run build
npx onlyonce-cli deploy ./dist

Custom Build

# Build your app
npm run build

# Deploy
npx onlyonce-cli deploy ./custom-build-folder

Requirements

• Node.js 18+
• Only-Once server running (see only-once)
• Built frontend project with index.html

Troubleshooting

"Could not detect build directory"

Make sure you're in the project root and have built your project, or specify the directory manually:

npx onlyonce-cli deploy ./build

"Could not connect to Only-Once API"

1. Make sure the Only-Once server is running
2. Check the API URL: export ONLY_ONCE_API_URL=http://your-server:3000
3. Verify network connectivity

"Directory does not contain index.html"

Make sure you're deploying the built/compiled output, not the source code. Most frameworks require a build step:

npm run build  # or yarn build, etc.
npx onlyonce-cli deploy ./build

License

ISC