Getting Started

Putnami lets you build, run, and deploy full-stack applications from a single CLI. It supports multi-project workspaces, multiple runtimes, and a path from local development to production.

In this guide, you'll get a running app in under 3 minutes.

Install putnami

curl -fsSL https://putnami.dev/install.sh | bash

Prefer not to run an install script? See alternative installation options.

Create a project

putnami init --workspace my-project --project my-app --extension ts
cd my-project

This sets up everything you need:

package.json with recommended workspace tooling dependencies (putnami, language extensions, git tooling, ...)
Git repository initialized with a .gitignore
.putnamirc.json created at the workspace root for workspace identification
Extensions auto-detected and registered
my-app project scaffolded from the template selected by --extension (typescript-web, go-server, or python-server)
Dependencies installed via putnami install (and extension workspace installers when relevant)

Run your app

putnami serve my-app

Open http://localhost:3000

You now have a running Putnami app.

What Just Happened

You interacted with three core pieces of Putnami:

Workspace — The root container that organizes projects and tooling, identified by a .putnamirc.json file at the root. Learn more
Project — A deployable application inside the workspace (your packages/my-app/ directory). Learn more
CLI — The putnami command that orchestrates development and runtime. Reference

You didn't configure anything yet. Defaults are intentional.

Continue From Here

Common next steps:

Build a React web app — Customize pages, layouts, and data loading
Build an API service — Add an API project with file-based routing
Share code between projects — Create a shared library and use it across projects