Installation
Install the CLI globally.Authenticate
Set an API key in the environment where the CLI runs.KAVENIO_API_TOKEN is also supported. If both are set, the CLI uses
KAVENIO_API_TOKEN.
Use health when an agent or script needs to verify the same setup:
Get started
Choose a stable profile key from your app, start a hosted account connection, then use the connected account to publish.authorizationUrl. Open it for the user or
pass it into the browser flow your agent is controlling.
After the connection completes, Kavenio redirects to returnTo with query
parameters such as accountId, profileId, and platform.
accountId when you want to publish to every connected account for that
platform inside the profile key.
What you can do
- Connect accounts:
kavenio connect begin,kavenio connect providers. - Connect Bluesky with App Password credentials:
kavenio connect bluesky --profile-id customer_user_123 --identifier name.bsky.social --app-password app-password. - Manage platform keys:
kavenio platform-keys list,kavenio platform-keys upsert. - Inspect accounts:
kavenio accounts list,kavenio accounts health. - Publish content:
kavenio posts create --profile-id customer_user_123 --content "Hello" --publish-now --platform linkedin:acc_123. - Validate content:
kavenio validate post --file post.json. - Upload and validate media:
kavenio media presign,kavenio media validate. - Manage Google Business:
kavenio accounts gmb-location-details,kavenio accounts gmb-reviews. - Read Google Business analytics:
kavenio analytics googlebusiness-performance. - Manage Bluesky text DMs:
kavenio accounts bluesky-conversations,kavenio accounts bluesky-messages,kavenio accounts bluesky-message-send,kavenio accounts bluesky-conversation-read, andkavenio accounts bluesky-conversation-archive. - Manage queues:
kavenio queue preview,kavenio queue next-slot. - Configure webhooks:
kavenio webhooks create --file webhook.json. - Work with ads:
kavenio ads list,kavenio ads create --file ad.json.
kavenio --help for the full command list.
Agent usage
The CLI is useful for AI agents because it gives them a narrow, structured way to inspect and operate Kavenio without writing application code first. Typical agent tasks:- Verify credentials with
kavenio health. - Choose or derive the correct profile key from the customer app.
- Start a connection flow and return the
authorizationUrl. - Configure or inspect platform keys before starting provider connection flows.
- Read connected account IDs from
kavenio accounts list. - Validate a post payload before publishing.
- Inspect webhook delivery logs after an event fails.
Platform key commands
Use platform keys when a workspace should connect, refresh, publish, or run ads with its own provider app credentials.--scope system.
Google Business commands
Use the standard connect command to start OAuth:accounts gmb-*.
analytics.
Bluesky commands
Bluesky uses credential connection with a Bluesky identifier and App Password, not OAuth:posts commands for creation,
validation, analytics, comments, and unpublish. Text-only Bluesky DMs are
account commands:
Related docs
Quickstart
Connect an account and publish the first post.
Node SDK
Use the SDK in application code.
FAQ
Should I use the CLI or SDK?
Use the SDK in application code. Use the CLI for agents, scripts, local checks, and operational tasks.Does the CLI replace the dashboard?
No. Use the dashboard for visual account management and workspace settings. Use the CLI when structured JSON output or automation is more useful.Where are all command options documented?
Runkavenio --help. The docs page stays short on purpose; the CLI itself is
the source of truth for command flags.