CLI Reference

The VENI-AI platform includes a powerful Command Line Interface (CLI) utility to automate infrastructure management, application scaffolding, and platform registration.

1. Installation

The CLI is built with Bun and can be run directly from the root using bun run.

# Register the veni command globally (optional)
bun link

---

2. Command Reference

Scaffold New App

Creates a new microfrontend and satellite API using the standard veni-service template.

bun run cli/src/index.ts create app <appname>

• Automated Port Assignment: Automatically picks the next available ports (API: 3012+, UI: 4175+).
• Template Variable Replacement: Replaces , , etc.
• Git Initialization: Initializes a new repository in apps/<appname>/.

Service Registration

Registers a running satellite app with the Shell API.

bun run cli/src/index.ts register <appname> \
  --api-url http://localhost:<apiPort>/api \
  --ui-url  http://localhost:<uiPort>

Build CLI

Compiles the TypeScript source into a fast, standalone binary.

cd cli && bun run build

---

3. Platform Conventions

The CLI enforces the following conventions during scaffolding:

Category	Convention
Directory	Satellite apps are always created in the apps/ directory.
Port Mapping	Increments from 3012 (API) and 4175 (UI) to prevent conflicts.
Naming	Uses PascalCase for class names and kebab-case for slug identifiers.
Auth	Automatically configures the AuthService to point to the Shell JWKS.