Getting Started

Putnami starts with one workspace model, then lets you choose the runtime surface that fits the first thing you want to build.

Use this page to get the CLI and workspace in place. If you already know the language you want, jump straight to the framework start guide:

You want to build... Start here
React SSR, API routes, or a TypeScript library TypeScript getting started
A Go service or Go library Go getting started
A Python service, library, or data workload Python getting started

Install putnami

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

Already installed? Update any time with putnami upgrade --global — the install script is only needed once per machine.

Prefer not to run an install script? Read the CLI reference for the command surface and install notes.

Create a workspace

mkdir my-project && cd my-project
putnami init

This creates the workspace root and shared assistant context:

  • .putnamirc.json identifies the workspace root
  • .AI/context.md, CLAUDE.md, and AGENTS.md give coding assistants the local conventions
  • installed extensions and templates become available to every project

Create your first project

Pick the template that matches the surface you want:

putnami projects create web --template typescript-web
putnami projects create api --template go-server
putnami projects create jobs --template python-server

Then install/sync dependencies and run the selected project:

putnami deps install
putnami serve web

Open the local URL printed by putnami serve.

What just happened

You interacted with three core pieces of Putnami:

  • Workspace - the root container that organizes projects, extensions, templates, and shared context. Learn more
  • Project - a runnable unit inside the workspace. Learn more
  • Template - the scaffold that gives a new project its language-specific shape. Reference
  • CLI - the command surface for build, test, lint, serve, publish, dependencies, and templates. Reference

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

Continue from here

Choose the path closest to your first project: