Skip to content
hupp docs

CLI reference

The output of hupp --help:

hupp — publish HTML and Markdown pages from your terminal

Usage:
  hupp comments <id> [--unresolved] [--json]
  hupp resolve <id> <comment-id>... [--json]
  hupp team ls [--json]
  hupp team create <name> [--json]
  hupp team invite <team> <email> [--json]
  hupp team rm <team> <email> [--json]
  hupp skill [install] [--dir=<path>]
  hupp login
  hupp logout
  hupp whoami [--json]
  hupp usage [--json]
  hupp upgrade
  hupp <file> [--name=<name>] [--ttl=<duration>] [--raw] [--no-comments]
              [--public | --team[=<name>] | --private] [--revises=<id>] [--json]
  hupp --version
  hupp --help

Arguments:
  <file>    HTML or Markdown file to publish. Use "-" to read from stdin.
  <id>      File id (the base62 part of the URL) or the whole share URL.
  <name>    Name for the team being created.
  <team>    Team name, or the team id `hupp team ls` prints.
  <email>   Address of the person to invite or remove.

Options:
  --dir=<path>         Directory `hupp skill install` writes into
                       [default: ./.claude/skills/hupp].
  -n --name=<name>     Filename shown in the URL path. Its extension picks the
                       input type; stdin defaults to HTML.
  -t --ttl=<duration>  Expire after a duration, e.g. 30m, 12h, 7d.
                       Free files expire 30 days after upload either way.
  -r --raw             Serve as text/plain instead of rendering.
  --no-comments        Publish without the comment widget.
  --revises=<id>       Mark as a new revision of a file you published. Comments
                       stay on the revision they were made on.
  --public             Anyone with the link can view [default].
  --team[=<name>]      Only members of that team can view. The name is required
                       when you belong to more than one team.
  --private            Only you can view, and only while signed in.
  -u --unresolved      List only comments nobody has resolved yet.
  -j --json            Print one JSON object on stdout and JSON errors on stderr.
  -h --help            Show this help.
  --version            Show version.

Exit codes:
  0  the command succeeded
  1  the request failed
  2  the command line was wrong

Environment:
  HUPP_TOKEN    API token used to authenticate. Overrides the token that
                `hupp login` stores in ~/.config/hupp/token.
  HUPP_API_URL  Base URL of the hupp API [default: https://hupp.ing].