Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Quickstart

Deploy your first project in under 2 minutes.

0. Install

curl -fsSL docs.getjack.org/install.sh | bash

Installs the CLI and configures MCP for your AI editor. Or try without installing: npx -y @getjack/jack new my-app

1. Create and Deploy

Pick a template and deploy.

Option A: API

Build a REST API, webhook handler, or backend service.

jack new my-api -t api

Includes: Hono router, TypeScript, CORS, health endpoint

Use for: Webhooks, REST APIs, microservices

Option B: AI Chat

Build a chatbot with streaming responses using free Cloudflare AI.

jack new my-chat -t ai-chat

Includes: Llama 3 (free), streaming UI, chat history

Use for: Chatbots, AI assistants, LLM experiments

Option C: Farcaster Miniapp

Build a Farcaster Frame mini-app with React and database.

jack new my-miniapp -t miniapp

Includes: React + Vite, D1 database, Neynar API, Tailwind CSS

Use for: Farcaster frames, social apps, mini-games

Requires: Neynar API key (free tier available)

Option D: Semantic Search

Build a RAG app with AI embeddings and vector search.

jack new my-search -t semantic-search

Includes: BGE embeddings (free), Vectorize database, D1 storage, search UI

Use for: Document search, knowledge bases, FAQ matching

Option E: Interactive Selection

Not sure? Let jack help you choose:

jack new my-app

Jack will prompt you to select a template interactively.

Jack handles everything: scaffolding, dependencies, and first deploy. Your app is live before you write a line of code.

2. Make Changes and Redeploy

Edit your code, then ship again:

cd my-app
 
jack ship

Each deploy takes seconds. Your changes are live immediately.

What's Next?

Add Services

Need a database, storage, or AI?

jack services db create
jack services storage create
jack services cron list

Set Secrets

Store API keys securely:

jack secrets

Open Your Project

Quick access to your deployed app:

jack open
 
jack open --editor

Explore Commands

See all available commands:

jack --help

Template Reference

TemplateCommandWhat You Get
apijack new my-api -t apiHono API with TypeScript
ai-chatjack new my-chat -t ai-chatAI chatbot with streaming
chatjack new my-chat -t chatReal-time AI chat rooms
miniappjack new my-app -t miniappFarcaster Frame mini-app
semantic-searchjack new my-search -t semantic-searchRAG with vector search
hellojack new my-app -t helloMinimal worker starter
nextjsjack new my-app -t nextjsNext.js on Cloudflare

Fork Any Published Project

See a project you like? Fork it:

jack new my-fork -t username/project-name

This creates your own copy that you fully control.

Resources