npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sparkpost-cli

v0.1.0

Published

A command-line interface to SparkPost.

Downloads

2

Readme

Sign up for a SparkPost account and visit our Developer Hub 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 <command> [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. PRs welcome :)

Contributing

We love community contributions. Checkout CONTRIBUTING.md and COMMANDS.md for guides on adding to the CLI.