Quick Start

Welcome to Titan Planet — a JavaScript-first backend framework powered by the Titan Engine Architecture.

You write zero Rust. Titan handles routing, bundling, runtime execution, hot reload, and deployment — executing your code inside a pre-compiled, highly optimized Rust binary.

⚙ Requirements

Before installing Titan, make sure you have the following installed:

Node.js v18+

Required for the Titan CLI and JavaScript bundling pipeline.

Rust (Optional)

Only required if you are building Native Rust Extensions (Hybrid Architecture).

Package Manager

Use npm, pnpm, or yarn — whichever you prefer.

Verify your setup:

node -v
npm -v

📦 Installation

Install the Titan CLI globally using your preferred package manager.

npm install -g @titanpl/cli@latest

pnpm add -g @titanpl/cli@latest

yarn global add @titanpl/cli@latest

Verify the installation:

titan --version

🚀 Create first server

Create your fist titan server using titan init

titan init my-app
# Follow the interactive prompt to choose your architecture

Inside your project:

cd my-app
npm install
npm run dev

You'll see the Titan Engine spin up instantly:

  ⏣ Titan Planet   v6.0.0   [ Dev Mode ]

  Type:        TS Actions
  Hot Reload:  Enabled
  Env:         Loaded

🚀 Starting Titan Engine...
[Titan] 1 reply route(s) pre-computed
Titan server running at: http://localhost:5100  (Threads: 32, Stack: 8MB, Dev Mode)

Titan will:

Read your routes and actions
Bundle them instantly with @titanpl/packet
Start the pre-compiled embedded engine
Hot-swap isolates on file changes

Migrating from Legacy Architecture

If you have an older Titan project (with a server/ directory), you can seamlessly migrate to the new Titan Engine:

Update CLI: npm install -g @titanpl/cli@latest
Migrate Project: In your project root, run titan migrate.
Install & Run: npm install then npm run dev.

Titan will automatically convert your project to use the embedded pre-compiled engine.