?

Deploy to Helpbase Cloud

Deploy your help center to company.helpbase.dev with a single CLI command.

clideployhosted
Edit on GitHub

Deploy to Helpbase Cloud

Warning

Hosted deploy is in beta. The core flow works (auth, slug reservation, content sync), but image upload and automatic cache revalidation are still in progress.

helpbase offers two deployment paths:

How hosted deploy works

content/ directory
      |
      v
helpbase deploy
  |-- Authenticate (Supabase magic link, cached)
  |-- Reserve subdomain slug
  |-- Validate all articles (frontmatter + schema)
  |-- Upload articles to Supabase
  |-- Upload categories to Supabase
  v
company.helpbase.dev is live

First deploy walkthrough

1

Run the deploy command

From your helpbase project directory:

npx helpbase deploy
2

Authenticate via magic link

Enter your email when prompted. Check your inbox for the magic link and click it. The CLI detects the authentication automatically and caches the session.

3

Choose your subdomain

Pick a slug for your help center URL. The CLI checks availability in real-time:

? Choose a subdomain: my-product
✓ my-product.helpbase.dev is available!
4

Content uploads automatically

The CLI reads your content/ directory, validates every article against the frontmatter schema, and uploads to Supabase. You see a progress indicator for each article.

5

Your site is live

✓ Deployed 8 articles across 3 categories
✓ Your help center is live at https://my-product.helpbase.dev

Updating content

After the first deploy, subsequent updates are simpler:

# Edit your MDX files locally
# Then push the changes:
npx helpbase deploy

Authentication and subdomain selection are skipped (cached from the first run). Only changed articles are updated.

Self-hosted vs hosted

FeatureSelf-hostedHosted
HostingYour infrastructurehelpbase.dev
DomainYour domaincompany.helpbase.dev
Deploygit push + CIhelpbase deploy
ContentFilesystem MDXSupabase
Custom codeFull controlMDX components only
CostYour hosting costsFree tier available
Tip

You can start with hosted deploy and migrate to self-hosted later. The content format is identical. Copy your content/ directory to a scaffolded project and deploy to your own infrastructure.