{"id":18783918,"url":"https://github.com/sparkpost/node-sparkpost-cli","last_synced_at":"2025-08-04T01:33:51.017Z","repository":{"id":57366972,"uuid":"79262069","full_name":"SparkPost/node-sparkpost-cli","owner":"SparkPost","description":"A command-line interface to SparkPost.","archived":false,"fork":false,"pushed_at":"2018-03-27T19:58:19.000Z","size":48,"stargazers_count":5,"open_issues_count":10,"forks_count":1,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-04-13T12:26:09.484Z","etag":null,"topics":["cli","email","node","sparkpost"],"latest_commit_sha":null,"homepage":"https://www.sparkpost.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SparkPost.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-17T19:13:00.000Z","updated_at":"2018-03-27T19:58:20.000Z","dependencies_parsed_at":"2022-08-23T20:11:04.423Z","dependency_job_id":null,"html_url":"https://github.com/SparkPost/node-sparkpost-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SparkPost%2Fnode-sparkpost-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SparkPost%2Fnode-sparkpost-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SparkPost%2Fnode-sparkpost-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SparkPost%2Fnode-sparkpost-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SparkPost","download_url":"https://codeload.github.com/SparkPost/node-sparkpost-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248713200,"owners_count":21149650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","email","node","sparkpost"],"created_at":"2024-11-07T20:41:10.338Z","updated_at":"2025-04-13T12:26:13.228Z","avatar_url":"https://github.com/SparkPost.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://www.sparkpost.com\"\u003e\u003cimg src=\"https://www.sparkpost.com/sites/default/files/attachments/SparkPost_Logo_2-Color_Gray-Orange_RGB.svg\" width=\"200px\"/\u003e\u003c/a\u003e\n\n[Sign up][sparkpost sign up] for a SparkPost account and visit our [Developer Hub](https://developers.sparkpost.com) for even more content.\n\n# SparkPost Command Line Interface\n\nA command-line interface to SparkPost.\n\n\n## Installation\n\nThe easiest way to install the CLI is through npm.\n\n```\nnpm install sparkpost-cli -g\n```\n\nYou can also clone the github repo and use a symlink.\n\n```\ngit clone https://github.com/SparkPost/node-sparkpost-cli.git\ncd ./node-sparkpost-cli\nnpm link\n```\n\n\n## Configuring\nTo 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.\n\n```\n// using an env variable\nexport SPARKPOST_API_KEY=MY_SPARKPOST_API_KEY\n// using the CLI\nsparkpost config --key=MY_SPARKPOST_API_KEY\n```\n\n\n## Getting Help\n\n### `--help`\nUse the `--help` flag on any command to get information about any subcommands and options it takes.\n\n```\nsparkpost inbound-domains --help\n```\n```\nUsage: sparkpost inbound-domains \u003ccommand\u003e [options]\n\nCommands:\n  create  create a inbound domain\n  delete  delete a inbound domain\n  get     get a inbound domain\n  list    list inbound domains\n\nOptions:\n  --version  Show version number  [boolean]\n  --help     Show help  [boolean]\n  --docs     Open documentation  [boolean]\n```\n\n### `--docs`\nOn any of the endpoint commands you can use the `--docs` flag to open up the full documentation in your browser.\n\n```\nsparkpost sending-domains --docs\n```\n\n\n## Basic Commands\nFor a full list of commands run `sparkpost --help`.\n\n* `sparkpost config` - Configure the CLI to your account\n* `sparkpost account` - Get your account information\n* `sparkpost [endpoint] [command]` - Call the specified endpoint and command \u003cbr\u003eSupported endpoints include: `inbound-domains`, `message-events`, `relay-webhooks`, `sending-domains`, `subaccounts`, `webhooks`\n\n\n## Tips\n* Using an elite account? Set `sparkpost config --origin=YOUR_ORIGIN` to use the CLI.\n* 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 :)\n\n\n# Contributing\n\nWe 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. \n\n[sparkpost sign up]: https://app.sparkpost.com/join\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkpost%2Fnode-sparkpost-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsparkpost%2Fnode-sparkpost-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkpost%2Fnode-sparkpost-cli/lists"}