@briefroom/cli

@briefroom/cli

Command-line interface for briefroom.

Install

npm i -g @briefroom/cli
# or use npx (no install)
npx @briefroom/cli <command>

Commands

briefroom login                 # Browser-based PKCE login, PAT saved to OS keychain
briefroom login --token <pat>   # CI use: save PAT directly, skip browser
briefroom whoami                # Show current user (or --json)
briefroom logout                # Remove PAT from keychain (does NOT revoke server-side)
briefroom deploy [dir]          # Zip a directory and upload it, returns a share URL (default dir: .)
briefroom list                  # List your rooms (--json, --limit, --archived)
briefroom revoke <share_id>     # Immediately revoke a share URL
briefroom feedback pull <share_id> --format prompt  # Pull comments as LLM-ready Markdown

deploy

Zips a directory (excluding .git / node_modules / .env* / keys) and uploads it. On the first deploy it writes briefroom.json so subsequent deploys target the same room and keep the same share URL.

briefroom deploy ./                       # deploy the current directory
briefroom deploy ./ --new                 # force a brand-new room
briefroom deploy ./ --room my-proposal    # target a specific room slug
briefroom deploy ./ --expires 7d          # expiry: 7d (default) | 30d | never
briefroom deploy ./ --password 's3cret'   # password-protect the link (Pro+ plans)
briefroom deploy ./ --visibility unlisted # remove an existing password (unlist the link)
briefroom deploy ./ --no-password         # same as --visibility unlisted
briefroom deploy ./ --json                # print the result as a single JSON line

• On a redeploy, --expires / --password / --visibility are applied to the existing share link (same URL). Flags you omit are left unchanged, so a plain briefroom deploy ./ never resets a "never" expiry or an existing password.
• --password requires a Pro+ plan (Free returns an error). It also reads the BRIEFROOM_SHARE_PASSWORD environment variable, which is preferred over --password because it keeps the secret out of the process list (ps). Passing a password together with --no-password or --visibility unlisted is rejected.

Configuration

• BRIEFROOM_API_URL env or --api-url flag — default https://briefroom.net
• BRIEFROOM_TOKEN env — PAT used for auth (falls back to the OS keychain from briefroom login)
• BRIEFROOM_SHARE_PASSWORD env — password for deploy when you don't want it in argv

License

MIT