blimp-cli

Publish and manage single-page HTML sites on blimp from your terminal.

blimp hosts a self-contained HTML file (or a directory containing index.html) and gives you back a shareable URL — https://{slug}.blimp.page. Optional password gate, auto-expiry, and custom slug.

Install

Run it on demand with npx:

npx blimp-cli@latest --help

Or install globally so the command is just blimp:

npm install -g blimp-cli
blimp --help

Requires Node.js 18 or newer.

Getting started

# 1. Save your API URL + token to ~/.blimp/config.json
blimp login

# 2. Publish an HTML file — prints the shareable URL
blimp publish ./report.html

# Publish a directory (must contain index.html)
blimp publish ./site

Commands

| Command | Description | | --- | --- | | blimp login | Configure API URL and token (saved to ~/.blimp/config.json, mode 0600). | | blimp publish <path> | Publish an HTML file, or a directory containing index.html. | | blimp list (ls) | List your active sites. | | blimp update <slug> | Update a site's content or metadata. | | blimp pull <slug> [dir] | Download a site's files to a directory, or a .zip with --zip. | | blimp delete <slug> (rm) | Delete a site (-y to skip the confirmation prompt). |

publish

blimp publish <path> [options]

  -s, --slug <slug>          Custom slug
  -t, --title <title>        Friendly title
  -p, --password <password>  Set a password
  -e, --expires-days <days>  Expire in N days

Outputs only the URL on stdout (progress goes to stderr), so it composes cleanly in scripts:

URL=$(blimp publish ./report.html --expires-days 7)
echo "Published to $URL"

update

blimp update <slug> [options]

  -f, --file <file>          Replace content with this file (or directory)
  -s, --slug <newSlug>       Rename the slug
  -t, --title <title>        Set title
  -p, --password <password>  Set password
      --clear-password       Remove password protection
  -e, --expires-days <days>  Expire in N days
      --clear-expiry         Clear expiry (never expire)

pull

blimp pull <slug> [dir]      # writes files into ./<slug> (or [dir])
blimp pull <slug> --zip out.zip

Configuration

Credentials live in ~/.blimp/config.json:

{
  "apiUrl": "https://api.blimp.page/api/v1",
  "token": "blimp_xxx"
}

Run blimp login to create or update it.

License

MIT