4. CLI Reference

The Titan CLI is the central tool for managing your Titan Planet projects.

Installation

npm install -g @titanpl/cli

Project Commands

titan init <name>

Scaffolds a new Titan project.

• Interactive Prompts: Choose between JavaScript (Standard) or Rust + JavaScript (Beta).
• Template selection: Sets up the necessary structure and package.json configuration.

titan dev

Starts the Titan development server with hot reload.

• Bundling: Uses esbuild to bundle JavaScript actions.
• Compilation: Compiles Rust code and the native server.
• Hot Reload: Watches for file changes and restarts the orbit instantly.

titan build

Compiles your application for production.

• --release: Generates a self-contained production bundle in the build/ directory, including the engine binary and pre-computed routes.

titan update

Syncs and generates necessary native files and configurations.

• Migration: Essential when enabling Rust Actions in an existing project.
• Core Sync: Ensures your project's native wrapper matches your local CLI version.
• Automation: Re-downloads and configures the native core based on your package.json settings.

Extension Commands

titan create ext <name>

Scaffolds a new Titan extension in a subdirectory.

• Options: Select between js, wasm, or native types.
• Structure: Creates titan.json, along with the necessary boilerplate files for the selected type (e.g., index.js, Rust source, or WASM configuration).

titan build ext

Compiles WASM or Native extensions for distribution.

• WASM: Compiles Rust to .wasm (requires Rust toolchain).
• Native: Compiles Rust/C++ to platform-specific binaries (.dll/.so).

titan run ext

Runs the Extension Test Harness.

• Virtual Project: Sets up a temporary Titan environment.
• Native Link: Links your local native code to the test runner.
• Test Server: Starts a server where you can verify your extension logic.

Help & Version

titan --help

Displays help information for all commands.

titan --version

Displays the current version of the Titan CLI.