@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 ./ --name '企画書 v2'    # room display name (any language)
briefroom deploy ./ --expires 7d          # expiry: 24h | 7d (default) | 30d | 90d | 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 ./ --private             # private room: only you, signed in, can open it
briefroom deploy ./ --no-comments         # hide the comment sidebar (viewers see the page + header only)
briefroom deploy ./ --display-mode live   # live mode: chrome-less full-screen page (default: review)
briefroom deploy ./ --json                # print the result as a single JSON line

• On a redeploy, --expires / --password / --visibility / --no-comments (--comments) / --display-mode 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, an existing password, or a comments-off / live setting.
• --expires accepts 24h | 7d | 30d | 90d | never. The Free plan allows 24h and 7d only (30d / 90d / never need Pro+; private rooms are exempt).
• --no-comments hides the comment sidebar entirely — viewers only see the page and the briefroom header (version switcher included). Existing comments are kept and stay visible to you on the dashboard and via feedback pull. --comments turns the sidebar back on. Every plan.
• --display-mode live shows the page full-screen with no briefroom UI at all (no header, no comments); --display-mode review (the default) is the header + comment sidebar. Every plan.
• --name sets the room display name shown on the dashboard and in the viewer (1-100 chars, any language including Japanese). It is not the same thing as --room: the room slug is an ascii identifier used only to decide which existing room to redeploy into, and it never appears in the share URL (that always ends in an auto-issued random token). Without --name, the first deploy falls back to the slug and a redeploy keeps the current name, so a room you renamed on the dashboard is never silently overwritten by a local value.
• --private makes the room private: the share URL only opens for you while you are signed in to briefroom, so an AI agent can keep overwriting the same URL without it being readable by anyone who has the link. It is available on every plan, does not count toward the shared-room limit, and can be combined with --expires never. It is shorthand for --visibility email_invite_only; adding invitees later (from the dashboard) turns it back into a normal invite-only share.
• --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