@evenrealities/evenhub-cli
v0.1.5
Published
Command-line interface for EvenHub development and app management.
Readme
EvenHub CLI
Command-line interface for EvenHub development and app management.
Quick Start
For development mode with the Even app, the qr command is the only command you need in this phase.
Commands
qr - Generate QR Code
Generate a QR code for your development server URL. This is the primary command for using dev mode with the Even app.
Basic usage:
evenhub qrThe command will automatically detect your local IP address and prompt you for the port and path. On subsequent runs, it will remember your previous settings.
Options:
-u, --url <url>- Provide a full URL directly (overrides other options)-i, --ip <ip>- Specify the IP address or hostname-p, --port [port]- Specify the port (leave empty for no port)--path <path>- Specify the URL path--https- Use HTTPS instead of HTTP--http- Use HTTP instead of HTTPS-e, --external- Open QR code in an external program instead of terminal-s, --scale <scale>- Scale factor for external QR code (default: 4)--clear- Clear cached scheme, IP, port, and path settings
Examples:
# Generate QR code with auto-detected IP
evenhub qr
# Generate QR code for a specific URL
evenhub qr --url http://192.168.1.100:3000
# Generate QR code with specific IP and port
evenhub qr --ip 192.168.1.100 --port 3000
# Open QR code externally
evenhub qr --externalinit - Initialize Project
Initialize a new project with a basic app.json configuration file.
Usage:
evenhub init [options]Options:
-d, --directory <directory>- Directory to create the project in (default:./)-o, --output <output>- Output file path (takes precedence over--directory, default:./app.json)
Example:
evenhub init
evenhub init --directory ./my-app
evenhub init --output ./config/app.jsonlogin - Login to EvenHub
Log in using your Even Realities account (same one used in app). Credentials are saved locally for future use.
Usage:
evenhub login [options]Options:
-e, --email <email>- Your email address
Example:
evenhub login
evenhub login --email [email protected]pack - Pack Project
Pack your project into an .ehpk file ready for app creation/submit.
Usage:
evenhub pack <json> <project> [options]Arguments:
<json>- Path to yourapp.jsonmetadata file<project>- Path to your built project folder (e.g.,dist,build)
Options:
-o, --output <output>- Output file name (default:out.ehpk)--no-ignore- Include hidden files (those starting with.)-c, --check- Check if the package ID is available
Example:
evenhub pack app.json ./dist
evenhub pack app.json ./build --output my-app.ehpk
evenhub pack app.json ./dist --check