https://github.com/sailthru/sailthru-cli
Command Line Interface for Sailthru API
https://github.com/sailthru/sailthru-cli
Last synced: 13 days ago
JSON representation
Command Line Interface for Sailthru API
- Host: GitHub
- URL: https://github.com/sailthru/sailthru-cli
- Owner: sailthru
- License: mit
- Created: 2012-01-16T01:13:50.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2014-01-31T16:59:20.000Z (over 11 years ago)
- Last Synced: 2025-05-07T13:56:26.302Z (13 days ago)
- Language: CoffeeScript
- Homepage:
- Size: 160 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
sailthru-cli
=============
Command Line Interface for `Sailthru API` as per [http://docs.sailthru.com/api](http://docs.sailthru.com/api)
CLI command is divided into 3 parts:
* VERB: `GET` / `DELETE` / `POST` [Case insensitive; if non of them then, uses GET]
* Action: Any valid actions listed on[http://docs.sailthru.com/api](http://docs.sailthru.com/api)
* Payload `Valid JSON` payload like: `{"email": "[email protected]"}`
Installation
------------
npm install sailthru-cli -g
If node is not installed, install it from [http://nodejs.org](http://nodejs.org/)
Usage
------
### Usage without config file
sailthru-cli --key *** --secret ***
### Usage with config file
sailthru-cli --config ~/client.1226.json
If `--url` is not defined in the command or `apiUrl` is not present in the config file then, by default `https://api.sailthru,com` will be used which in most of the cases should work
Config File
------------
{
"apiKey": "****",
"apiSecret": "***",
"apiUrl": "https://api.sailthru.com"
}
JSON Payload
------------
### Valid Payload
{"email": "[email protected]"}
### Invalid Payload
{'email': "[email protected]"}
Screenshot
----------
