CLI Reference
headshotmarketing from @headshotmarketing/cli. A thin shell over @burdenoff/cli-sdk that mounts the HeadshotMarketing product context and wires the Commander program.
Install
# From npmjs (public)
npm install -g @headshotmarketing/cli
# or
bun add -g @headshotmarketing/cli
Environment
The CLI targets production by default. Set BURDENOFF_ENV to switch:
# Prod (default)
headshotmarketing auth login
# Alpha
BURDENOFF_ENV=alpha headshotmarketing auth login
# Local
BURDENOFF_ENV=local headshotmarketing auth login
Override endpoints directly:
| Variable | Default |
|---|---|
HEADSHOTMARKETING_WORKSPACE_ENDPOINT | https://graphqlworkspaces.burdenoff.com/workspaces/graphql |
HEADSHOTMARKETING_GLOBAL_ENDPOINT | https://graphql.burdenoff.com/global/graphql |
HEADSHOTMARKETING_OIDC_ISSUER | https://graphql.burdenoff.com/global |
Top-level command groups
| Group | What |
|---|---|
auth | Authentication (login, logout, status, token, refresh) |
workspace | Workspace context (list, current, set) |
organizations | Organization management |
tours | Product tours |
rbac | Role-based access control |
headshotmarketing | Marketing operations — campaigns, CRM, pipeline, social, ads, influencers, content, events, SEO, builder, workflows, analytics |
sandbox | Sandbox script execution |
tags | Tags |
files | Files |
groups | Groups |
conversations | Conversations |
security | Security |
integrations | Integrations |
channels | Channels |
scheduler | Scheduler |
export | Data export |
notifications | Notifications |
support | Support |
products | Products / feature flags |
billing | Billing |
store | Store |
devportal | Developer portal |
health | Health checks |
Run headshotmarketing <command> --help for subcommand details.
Common examples
# Auth
headshotmarketing auth login
headshotmarketing auth status
headshotmarketing auth token --workspace
# Workspace
headshotmarketing workspace list
headshotmarketing workspace set <id>
# Marketing operations
headshotmarketing headshotmarketing campaigns list
headshotmarketing headshotmarketing contacts list
headshotmarketing headshotmarketing deals list
# Shared platform
headshotmarketing tags create --key urgent --label Urgent
headshotmarketing rbac check <user> read campaign
headshotmarketing billing subscriptions list
headshotmarketing devportal apps list --status PUBLISHED
Output formats
All list/get commands support --format (-f): json, table, yaml.
headshotmarketing headshotmarketing campaigns list --format json
Token storage
Tokens are stored at ~/.config/headshotmarketing-cli/auth.json (mode 0600).
Development
git clone https://github.com/Algoshred/headshotmarketing-cli.git
cd headshotmarketing-cli
bun install
bun run dev -- --help # Dev mode with args
bun run build # Compile TypeScript
bun run sanity # format + lint + type-check + test + build