SendKit CLI introduction
Install and run the SendKit CLI from your terminal or AI agents that can execute shell commands, with a quick sanity check and common workflow overview.
Overview
Use the SendKit CLI to interact with SendKit from your terminal or from AI agents that can execute shell commands. The CLI gives you a command-line entry point to run SendKit actions without writing full application code.
Prerequisites
- Node.js (LTS or later)
- npm (installed with Node.js on most systems)
Install and first run
Install the CLI with npm so you can call it from your terminal or via npx.
Install the SendKit CLI
Use npm to install the CLI package. The simplest form is:
npm i @sendkit-ai/cli
To install it globally:
npm install -g @sendkit-ai/cli
Or add it to your devDependencies instead:
npm install --save-dev @sendkit-ai/cli
Verify the installation
Run the CLI with the --help flag to confirm it works and see the available options.
# Recommended: via npx
npx @sendkit-ai/cli --help
# If your environment exposes a `sendkit` command after a global install
sendkit --help
When the CLI is installed correctly, your terminal prints a help screen describing the available commands and flags.
Using the CLI with AI agents
Configure the SendKit CLI as part of your toolchain when you use an AI agent that can execute shell commands. The agent can then invoke the CLI in the same way you do from your terminal, for example:
npx @sendkit-ai/cli --help
If your agent environment exposes a sendkit command after a global install, the agent can call that binary as well. The exact integration steps depend on how your agent framework defines and runs shell tools.
Common workflows
Use the SendKit CLI for everyday development and automation tasks such as:
- Manage and sync message templates
- Send test messages against staging or sandbox environments
- Trigger SendKit actions from CI pipelines
- Inspect configuration and environment details
- Run diagnostics or health checks on SendKit integrations
As the CLI evolves, run the help command regularly to discover new or updated capabilities.
npx @sendkit-ai/cli --help
Next steps
Connect the CLI with the rest of your SendKit setup:
- Follow the Getting Started guide to configure accounts, keys, and basic API usage.
- Explore the Endpoints section of the API reference to understand which actions you might script or wrap with CLI workflows.
Last updated today
Built with Documentation.AI