@cheerful/cli
v0.1.2
Published
Cheerful platform CLI — run campaigns, creator search, the inbox and reporting from your terminal
Readme
@cheerful/cli
Command-line interface for Cheerful, the AI-native influencer marketing platform. Run campaigns, creator search, the inbox, drafts and reporting from your terminal — JSON output by default, so every command pipes into a script.
Install
npm install -g @cheerful/cliInstalls a native binary for your platform: macOS (Apple Silicon or Intel), Linux x64, or Windows x64. There is no Linux arm64 build.
Sign in
cheerful auth login # opens your browser
cheerful auth whoami # which account am I acting as?There is no API key. Cheerful does not issue static keys — auth login
signs you in through the browser as yourself, and the session carries exactly
your own permissions. See
cheerful.ai/developers/api-keys
for what that means, including the fact that unattended use (CI, cron, a
headless runner) is not supported today.
Five real commands
# what am I running?
cheerful campaigns list --status active --pretty
# what is blocked on a human?
cheerful threads list --status DRAFT_READY,WAITING_FOR_DRAFT_REVIEW --pretty
# what came back today?
cheerful inbox list --tab pending --limit 20 --pretty
# is anything disconnected?
cheerful integrations status --pretty
# get a campaign's numbers out
cheerful analytics export --campaign-id <id> --output analytics.csvOutput is JSON unless you pass --pretty, which is the right default for a
tool other things call: a table breaks every script the first time a column is
added.
cheerful campaigns list --status active | jq 'length'Two things that will bite you
- The default request timeout is 30 seconds. A creator search genuinely
takes 90–155 seconds, so
cheerful creators searchneeds--timeout 200or it gives up on a call that was working. - This is not read-only.
campaigns launchlaunches,email sendsends, andrules bulk-editchanges what every future draft is generated against. Treat a signed-in terminal the way you treat a logged-in browser tab, and runcheerful auth whoamibefore anything that writes.
Everything else
cheerful --help, or cheerful <group> --help for one of the 25 command
groups. Full documentation:
Cheerful also runs a remote MCP server at https://mcp.cheerful.ai/mcp, so
Claude, ChatGPT or any MCP client can read your campaigns and replies using
your own account —
connect it in about a minute. Unlike
this CLI, the connector is read-only.
Supported platforms
| Platform | Architecture | | --- | --- | | macOS | Apple Silicon (arm64), Intel (x64) | | Linux | x64 | | Windows | x64 |
License
MIT
