htmx Cheat Sheet
Practical htmx cheat sheet with setup steps, core workflows, debugging, and copy-paste examples.
htmx framework web-dev deployment
htmx cheat sheet with real commands and snippets for setup, core workflows, debugging, and production-safe automation patterns. If you are working across tools, pair this with the JavaScript Cheat Sheet and Flask Cheat Sheet.
Setup and Installation
Goal: Create a fresh project
# Scaffold project using official starter
mkdir htmx-demo && cd htmx-demo
# Install dependencies after scaffold completes
python -m http.server 8080
Goal: Verify local toolchain versions
# Print Node.js runtime version
node --version
# Print npm version for lockfile consistency
npm --version
# Inspect package scripts in project
cat package.json | rg "scripts" -n
Core Development Workflow
Goal: Run local development server
# Start framework dev server with hot reload
python -m http.server 8080
# Check local endpoint health
curl -I http://localhost:3000 || curl -I http://localhost:5173 || true
Goal: Build and preview production output
# Build optimized production assets
echo 'HTMX is server-driven; no build step required.'
# Run production preview server
curl -I http://127.0.0.1:8080
Goal: Implement a core feature snippet
<!-- HTMX button that swaps server response into #result -->
<script src="https://unpkg.com/htmx.org@1.9.12"></script>
<button hx-get="/status" hx-target="#result" hx-swap="innerHTML">Load status</button>
<div id="result"></div>
Testing and Quality
Goal: Run tests and static checks
# Execute project tests
curl -I http://127.0.0.1:8080
# Run type checking when available
npm run check || npx tsc --noEmit || true
# Run linting for fast feedback
npm run lint || true
Deployment and Operations
Goal: Prepare deployment artifacts
# Create production build before deployment
echo 'HTMX is server-driven; no build step required.'
# Validate environment variables are set
node -e "console.log('NODE_ENV=', process.env.NODE_ENV || 'unset')"
# Smoke-test production route after deploy
curl -I https://devcheatsheets.com
Debugging and Troubleshooting
Goal: Inspect build and runtime failures
# Reinstall dependencies from lockfile
rm -rf node_modules && npm ci
# Re-run build with clean cache
npm run build
# Search source for suspect route/config patterns
rg "route|middleware|config" src app -n
Common Gotchas
- Run htmx builds locally before shipping to CI/CD environments.
- Keep environment secrets outside the repository and load them per environment.
- Avoid stale dependency locks by using npm ci in automation.
- Validate route and middleware behavior with explicit smoke tests.
- Keep framework and plugin versions aligned to avoid build regressions.
Related Sheets
- JavaScript Cheat Sheet — frontend and backend scripting patterns.
- Flask Cheat Sheet — daily Flask commands and production-ready examples.
- Next.js Cheat Sheet — daily Next.js commands and production-ready examples.
Related Cheat Sheets
JavaScript Cheat Sheet
Practical JavaScript cheat sheet with setup steps, core workflows, debugging, and copy-paste examples.
Flask Cheat Sheet
Practical Flask cheat sheet with setup steps, core workflows, debugging, and copy-paste examples.
Next.js Cheat Sheet
Practical Next.js cheat sheet with setup steps, core workflows, debugging, and copy-paste examples.