Skip to content

freewebstore-online/cli

Repository files navigation

@freewebstore/cli

Designer-side CLI for FreeWebStore. Scaffold an HTML+Tailwind template, vibecode the design, ship it to a small business website near you.

npx @freewebstore/cli init sofia-bistro --category=restaurant.italian
cd sofia-bistro
# vibecode index.html with Claude Code / Cursor / your editor of choice
# add a 1280×720 preview.png
npx @freewebstore/cli doctor    # local validation
npx @freewebstore/cli login     # one-time — opens browser to authorize
npx @freewebstore/cli publish   # upload + create repo + queue for review
npx @freewebstore/cli status sofia-bistro

Commands

Command What it does
fws init <slug> --category=<c> Scaffold a new template directory
fws doctor [--path=<dir>] Validate the template locally before publish
fws login Authorize via GitHub App (installs on your personal account)
fws logout Clear local auth
fws whoami Show current auth state
fws publish [--path=<dir>] Upload the template for review
fws status <slug> Check the status of a published template

How auth works

fws login opens your browser to install the FreeWebStore Templates GitHub App on your personal GitHub account. You do NOT need to be a member of the freewebstore-online org — the platform creates template repos in the org on your behalf when you fws publish.

What you get

  • Clients find you. Businesses that outgrow their free site come to you for custom work — on FreeWebStore or full CMS builds on ProWebStore.
  • Recognition. Every adopting site's footer credits you ("Template by @your-handle"), linked to your designer profile on freewebstore.online.
  • Social proof. Live adoption counter on your designer page — updated daily.
  • Portfolio. Permanent preview URL at templates.freewebstore.online/{slug}/. Share it, embed it, it doesn't expire.
  • Zero cost. You volunteer the HTML; the platform handles hosting, deploy, AI customization, and client matching.

How customization works

You write index.html with Tailwind utility classes. Mark customization points with data-fws-slot="business.name" etc. (see slots.md in your scaffolded directory).

When a small business picks your template, the FreeWebStore platform AI rewrites the slot contents per business. No templating language, no build step — pure HTML in, pure HTML out, AI bridges both sides.

Environment variables

Var Purpose
FREEWEBSTORE_CONFIG_DIR Override ~/.freewebstore/ (useful in CI)
FREEWEBSTORE_ADMIN_BASE Override admin Worker URL (useful for local dev / staging)

About

FreeWebStore CLI — @freewebstore/cli; scaffold + publish HTML+Tailwind templates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors