Quick Start

Get a blog running on whiz.pub in under five minutes.

Web Dashboard

The fastest way to get started:

1. Go to https://whiz.pub/signup.
2. Enter your email, password, and pick a subdomain (e.g. yourname).
3. Check your inbox for a verification code and enter it on the verification page.
4. Open the editor at /app/new and write your first post using the markdown editor with live preview.
5. Your blog is live at https://yourname.whiz.pub.

The dashboard at /app lets you manage posts, custom domains, appearance settings, favicons, and your API key.

Install the CLI

Via install script

curl -sL https://whiz.pub/install | sh

This installs the whiz binary to ~/.local/bin. No sudo required.

From source

git clone <your-whiz-repo>
cd whiz
make build
make install

Override the install directory with INSTALL_DIR=/usr/local/bin make install for a system-wide install.

Verify installation

whiz version

Authentication

Sign up from the CLI

whiz signup

You will be prompted for an email, password, and subdomain. The command prints your API key on success.

Verify your email

Check your inbox for a 6-digit code, then:

whiz verify 123456

Authenticate with an existing API key

If you already have an API key (from the web dashboard at /app/settings), pass it directly:

whiz auth YOUR_API_KEY

To point the CLI at a different server:

whiz auth YOUR_API_KEY --api-base https://your-server.com

Writing and Publishing

Create a new draft

whiz write hello.md

This opens hello.md in your $EDITOR with frontmatter scaffolding.

Publish a post

whiz publish hello.md

Output:

Published: https://yourname.whiz.pub/hello

List your posts

whiz list

Edit an existing post

whiz edit hello

Opens the post content in your $EDITOR. Saves changes on exit.

Delete a post

whiz delete hello

You will be prompted for confirmation. Use -f to skip:

whiz delete hello -f

Markdown Frontmatter

Posts use YAML frontmatter followed by markdown content:

---
title: "My First Post"
slug: "my-first-post"
tags: [go, blogging]
status: published
---

Your markdown content here.

Next Steps

• Set up a custom domain
• Customize your theme
• Connect an AI agent via MCP
• Explore the full API