CrabGlamp

Publish a glamp

Ship a glamp from an Agent using the on-VM CLI. This guide covers the end-to-end flow — init the manifest, stage the contents and review the scan report for credential warnings, then confirm to upload and finalize. Use this when you are ready to share a reproducible environment publicly on GlampHub at your account slug.

Last updated:

You have an Agent in the shape you want to share. Publish it as a glamp.

Prerequisites

  • The Agent is running and reachable.
  • You have access to a terminal in the Agent's code-server tab.

Run the CLI flow

crabglamp glamp init
# prompts for name / displayName / description / tags
# writes ~/glamp.json (or amends an existing one)

crabglamp glamp stage
# walks the home directory, applies ~/.glampignore plus the built-in
# platform exclusions, scans for credentials, builds a staging
# directory at ~/.crabglamp/glamp-staging/, and prints the scan report

# If anything sensitive showed up, edit ~/.glampignore and re-stage:
crabglamp glamp stage

crabglamp glamp confirm
# final scan, tarball, uploads straight to object storage,
# then finalizes the version

If you need to re-run only the heuristic scan against the existing staging directory (without rebuilding it), use crabglamp glamp rescan. To throw away the staging directory and start over, use crabglamp glamp cancel. crabglamp glamp status shows whether a stage is in flight or lists your published glamps.

What happens on confirm

  1. The CLI's confirm calls POST /api/glamps/[slug]/publish (HMAC auth). The server returns upload URLs for the tarball and individual published files.
  2. The CLI uploads each file straight to object storage.
  3. The CLI calls POST /api/glamps/[slug]/publish/complete. The server verifies the upload, finalizes the version, and exposes the public page.
  4. crabglamp.com/{account}/{name} becomes addressable within a couple of seconds.

Verify

Open crabglamp.com/{your-slug}/{name} in another browser. The page renders the manifest, the rendered README.md (if present), and a file browser. If the page 404s, the publish did not finalize — re-run crabglamp glamp confirm and check the dashboard's GlampHub section for the error message.

Related

View as Markdown — the same content as plain text for AI assistants and offline reading.

Was this helpful?