Package Exports
- viral-engine-cli
- viral-engine-cli/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (viral-engine-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Viral Engine CLI
Command-line interface for Viral Engine — generate AI images and videos, build funnels, manage leads, and run automations from your terminal.
Install
npm install -g viral-engine-cliRequires Node.js 18 or newer.
The CLI installs two binaries: viral-engine and the shorter alias ve.
Quick start
# Sign up (or log in if you already have an account)
ve signup
ve login
# Check your credit balance
ve credits
# Generate an image
ve images generate "a cinematic shot of a cyberpunk samurai at dusk" --model nano-banana-2
# Generate a video from a prompt
ve videos generate "a slow drone shot over a misty forest" --provider kling
# List the last 20 items in your gallery
ve gallery list --limit 20Run ve --help to see every command, or ve <command> --help for details on a specific one.
What you can do
| Area | Examples |
|---|---|
| Images | ve images generate, ve images enhance, ve images analyze |
| Videos | ve videos generate, ve videos extend, ve videos voiceover |
| VSL Studio | ve vsl run, ve vsl scripts |
| Gallery | ve gallery list, ve gallery favorite, ve gallery collections |
| Agents | ve agents list, ve agents create, ve agents run |
| Workflows | ve workflows list, ve workflows run |
| Funnels | ve funnels create, ve funnels publish |
| Leads | ve leads list, ve leads export |
| Automation | ve automation sequences, ve automation send-email |
| Account | ve credits, ve checkout, ve settings |
Configuration
Config lives at ~/.viral-engine/config.json and is created on first login.
# View current config
ve config show
# Change a default
ve config set defaultModel flux
ve config set defaultAspectRatio 9:16
# Point at a self-hosted instance
ve config set baseUrl https://your-instance.example.comPer-command overrides:
ve --base-url https://staging.viralengine.art images generate "..."
ve --token <your-token> credits
ve --json gallery list # raw JSON output for scripting
ve --quiet images generate # minimal output for pipelinesScripting
Every command supports --json for machine-readable output:
ve --json gallery list --limit 50 | jq '.items[].url'Long-running jobs (videos, batch image runs) return a job ID. Poll with:
JOB=$(ve --json videos generate "..." | jq -r .jobId)
ve jobs wait "$JOB"
ve jobs get "$JOB" --jsonAuthentication
The CLI stores your session token in ~/.viral-engine/config.json with 0700 permissions.
Log out at any time:
ve logoutUpdating
npm update -g viral-engine-cli
ve --versionLinks
- Website: https://viralengine.art
- API docs: https://viralengine.art/docs
- Support: https://viralengine.art/support
License
MIT