Installation

System requirements

Install the CLI

Install the CLI globally using your preferred package manager:

npm install -g @maravilla-labs/cli
# or
pnpm add -g @maravilla-labs/cli
# or
yarn global add @maravilla-labs/cli

Verify the installation:

maravilla --version

Initialize a project

Run maravilla init inside an existing project directory. The command detects your framework and configures the appropriate adapter:

cd my-app
maravilla init

Project structure after init

After initialization, your project will contain a .maravilla/ configuration directory. When you build, the adapter produces the following output structure:

.maravilla/
├── manifest.json       # Platform configuration
├── pipeline.yml        # CI/CD pipeline definition
├── server.js           # Bundled server application
├── server.js.map       # Source maps
├── functions/          # Serverless functions (when present)
└── static/             # Static assets and prerendered pages

The manifest.json describes your app’s routing, features, and environment configuration. The runtime reads this file to serve your application.

Authentication

Register for an account and authenticate the CLI:

# Create a new account
maravilla register

# Log in to an existing account
maravilla login

# Check the currently authenticated user
maravilla whoami

CLI commands

The CLI provides the following core commands:

Platform service management

Browse KV and database records interactively from the terminal:

# Launch interactive KV browser
maravilla platform kv

# Launch interactive database browser
maravilla platform db

# Show platform service status
maravilla platform status

Updating the CLI

Keep the CLI up to date with a single command:

maravilla update

Next steps

• Frameworks — configure SvelteKit, React Router, or Nitro-based frameworks
• Getting Started — quick start walkthrough