https://github.com/sparkpost/node-sparkpost-cli
A command-line interface to SparkPost.
https://github.com/sparkpost/node-sparkpost-cli
cli email node sparkpost
Last synced: 10 months ago
JSON representation
A command-line interface to SparkPost.
- Host: GitHub
- URL: https://github.com/sparkpost/node-sparkpost-cli
- Owner: SparkPost
- License: other
- Created: 2017-01-17T19:13:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-27T19:58:19.000Z (about 8 years ago)
- Last Synced: 2025-04-13T12:26:09.484Z (about 1 year ago)
- Topics: cli, email, node, sparkpost
- Language: JavaScript
- Homepage: https://www.sparkpost.com/
- Size: 46.9 KB
- Stars: 5
- Watchers: 41
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[Sign up][sparkpost sign up] for a SparkPost account and visit our [Developer Hub](https://developers.sparkpost.com) for even more content.
# SparkPost Command Line Interface
A command-line interface to SparkPost.
## Installation
The easiest way to install the CLI is through npm.
```
npm install sparkpost-cli -g
```
You can also clone the github repo and use a symlink.
```
git clone https://github.com/SparkPost/node-sparkpost-cli.git
cd ./node-sparkpost-cli
npm link
```
## Configuring
To start using the CLI you have to give it an API key associated with your account. You can specify your API key through the environment variable `SPARKPOST_API_KEY` or the `config` command.
```
// using an env variable
export SPARKPOST_API_KEY=MY_SPARKPOST_API_KEY
// using the CLI
sparkpost config --key=MY_SPARKPOST_API_KEY
```
## Getting Help
### `--help`
Use the `--help` flag on any command to get information about any subcommands and options it takes.
```
sparkpost inbound-domains --help
```
```
Usage: sparkpost inbound-domains [options]
Commands:
create create a inbound domain
delete delete a inbound domain
get get a inbound domain
list list inbound domains
Options:
--version Show version number [boolean]
--help Show help [boolean]
--docs Open documentation [boolean]
```
### `--docs`
On any of the endpoint commands you can use the `--docs` flag to open up the full documentation in your browser.
```
sparkpost sending-domains --docs
```
## Basic Commands
For a full list of commands run `sparkpost --help`.
* `sparkpost config` - Configure the CLI to your account
* `sparkpost account` - Get your account information
* `sparkpost [endpoint] [command]` - Call the specified endpoint and command
Supported endpoints include: `inbound-domains`, `message-events`, `relay-webhooks`, `sending-domains`, `subaccounts`, `webhooks`
## Tips
* Using an elite account? Set `sparkpost config --origin=YOUR_ORIGIN` to use the CLI.
* Note: this tool is still young. To migrate your suppression list from SendGrid or Mandrill, please use our other [CLI tool](https://github.com/SparkPost/sparkpost-cli). PRs welcome :)
# Contributing
We love community contributions. Checkout [CONTRIBUTING.md](https://github.com/SparkPost/node-sparkpost-cli/blob/master/CONTRIBUTING.md) and [COMMANDS.md](https://github.com/SparkPost/node-sparkpost-cli/blob/master/COMMANDS.md) for guides on adding to the CLI.
[sparkpost sign up]: https://app.sparkpost.com/join