Moose CLI Reference

Installation

bash -i <(curl -fsSL https://fiveonefour.com/install.sh) moose

Core Commands

Init

Initializes a new Moose project.

moose init <name> --template <template> [--location <location>] [--no-fail-already-exists]

• <name>: Name of your app or service
• <template>: Template to use for the project
• --location: Optional location for your app or service
• --no-fail-already-exists: Skip the directory existence check

List Templates

Lists available templates for project initialization.

moose template list

Build

Builds your Moose project.

moose build [--docker] [--amd64] [--arm64]

• --docker: Build for Docker
• --amd64: Build for AMD64 architecture
• --arm64: Build for ARM64 architecture

Dev

Starts a local development environment.

moose dev

Prod

Starts Moose in production mode for cloud deployments.

moose prod

Check

Checks the project for non-runtime errors.

moose check [--write-infra-map]

Clean

Clears temporary data and stops development infrastructure.

moose clean

Monitoring Commands

Logs

View Moose logs.

moose logs [--tail] [--filter <search_string>]

• --tail: Follow logs in real-time
• --filter: Filter logs by specific string

Ps

View Moose processes.

moose ps

Ls

View Moose primitives & infrastructure.

moose ls [--limit <n>] [--version <version>] [--streaming] [--type <type>] [--name <name>] [--json]

• --limit: Limit output (default: 10)
• --version: View specific version
• --streaming: View streaming topics
• --type: Filter by infrastructure type (tables, streams, ingestion, sql_resource, consumption)
• --name: Filter by name
• --json: Output in JSON format

Metrics

View live metrics from your Moose application.

moose metrics

Peek

View data from a data model.

moose peek <data_model_name> [--limit <n>] [--file <path>] [--topic]

• --limit: Number of rows to view (default: 5)
• --file: Output to a file
• --topic: Peek from topic instead of table

Generation Commands

Generate SDK

Generate an SDK for your data models.

moose generate sdk [--language <language>] [--destination <path>] [--project-location <path>] [--full-package] [--overwrite]

• --language: SDK language (default: typescript)
• --destination: Output directory (default: ./sdk)
• --project-location: Project location (default: .)
• --full-package: Generate full package
• --overwrite: Force overwrite existing files

Data Management

Import

Import data into a data model.

moose import <data_model_name> --file <path> [--format <format>] [--destination <url>] [--version <version>]

• --file: Path to import file
• --format: Import format
• --destination: Destination URL (default: http://localhost:4000/ingest)
• --version: Version

Workflow Management

Workflow

moose workflow <command> [options]

Available workflow commands:

• init <name> [--tasks <task-list>] [--task <task>...]: Initialize a new workflow
• run <name> [--input <json>]: Run a workflow
• resume <name> --from <task>: Resume a workflow from a specific task
• list [--status <status>] [--limit <n>]: List workflows
• terminate <name>: Terminate a workflow
• pause <name>: Pause a workflow
• unpause <name>: Unpause a workflow
• status <name> [--id <run-id>] [--verbose] [--json]: Get workflow status

Planning and Deployment

Plan

Display infrastructure changes for the next production deployment.

moose plan [--url <url>] [--token <token>]

• --url: Remote Moose instance URL (default: http://localhost:4000)
• --token: API token for authentication

This reference reflects the current state of the Moose CLI based on the source code in the framework-cli directory. The commands are organized by their primary functions and include all available options and flags.