htmx - Get Started

Before You Start

Any backend

htmx works with any server that returns HTML

HTML knowledge

htmx extends HTML attributes

Get It Running

Recommended

CDN (Quickest)

Add htmx to any HTML page.

These instructions work the same on Mac and Windows.

First, open your Terminal:

⌘ + Space → type "Terminal" → press Enter

1

Add the htmx script to your HTML head

2

Use hx-* attributes on your elements

3

Set up a backend to return HTML fragments

4

htmx will swap content automatically

First, open your Terminal:

Win + R → type "cmd" or "powershell" → press Enter

1

Add the htmx script to your HTML head

2

Use hx-* attributes on your elements

3

Set up a backend to return HTML fragments

4

htmx will swap content automatically

Example code:

<!-- Add to your HTML -->
<script src="https://unpkg.com/htmx.org@1.9.10"></script>

<!-- Use htmx attributes -->
<button hx-get="/api/data" hx-target="#result">
    Load Data
</button>
<div id="result"></div>

With npm

Install htmx as a package.

These instructions work the same on Mac and Windows.

First, open your Terminal:

⌘ + Space → type "Terminal" → press Enter

1

npm install htmx.org

2

Import in your JavaScript

3

Use hx-* attributes in your HTML

First, open your Terminal:

Win + R → type "cmd" or "powershell" → press Enter

1

npm install htmx.org

2

Import in your JavaScript

3

Use hx-* attributes in your HTML

Start Vibe Coding

Create your project, push to GitHub, and start coding with AI in one go.

First, make sure you have these installed:

Git - Version control
GitHub CLI - Create repos from terminal
Cursor - AI-powered code editor

Project Name

Download Setup Script Recommended

Download and run a script that sets up everything automatically.

How to run on Mac

1. Open Terminal (Cmd + Space, type "Terminal")

2. Navigate to Downloads: cd ~/Downloads

3. Run: chmod +x setup-*.sh && ./setup-*.sh

How to run on Windows

1. Open your Downloads folder

2. Double-click the .bat file

3. If warned, click "More info" → "Run anyway"

Manual Setup (Copy & Paste)

# Enter a project name above to generate your script

Paste this in your terminal to create your project, initialize git, push to GitHub, and open in Cursor.

Build with Claude Code

Use Claude Code to build your htmx project by describing what you want in plain English.

a

Get your Anthropic API key (one-time)

You'll need an API key to use Claude Code. It's free to sign up!

1. Go to console.anthropic.com and sign up or log in
2. Navigate to API Keys in the sidebar
3. Click Create Key and copy it somewhere safe

Get API Key

b

Add your API key to your system (one-time)

Run this in your terminal to save the key permanently. Replace your-api-key with your actual key.

echo 'export ANTHROPIC_API_KEY="your-api-key"' >> ~/.zshrc && source ~/.zshrc

This adds the key to your shell config so it's always available.

setx ANTHROPIC_API_KEY "your-api-key"

This sets a permanent environment variable. Restart your terminal after running this.

c

Install Claude Code (one-time setup)

Run this command once in your terminal from anywhere.

npm install -g @anthropic-ai/claude-code

d

Start Claude in your project

Navigate to your htmx project folder, then run:

claude

e

Describe what you want to build

Claude will read your project and help you build it. Try prompts like:

"Add a responsive navbar" "Create a contact form" "Add dark mode toggle" "Explain this code"

Learn more about Claude Code

Go Live

Ready to share your htmx project with the world? Deploy it in minutes.

Deploy Your Project

Learn More

htmx Documentation

htmx Examples