toastynerd / superagent-cli

Super Agent CLI

A command line interface for the superagent rest library. Designed to make testing JSON apis from the command line easier.

to install:

npm install -g superagent-cli

the super agent cli command is superagent and requests look like the following:

superagent or superagent -h to display help
superagent <url> <rest method(get|post|put|patch|delete)> <json data>
superagent www.google.com
superagent www.google.com get
superagent localhost:3000 post '{"hello":"world"}'
superagent localhost:3000 post {hello: \'world\'}

Note: if using javascript literal notation (instead of fully qualified JSON) all quotes around string must be escaped ex: {hello: 'world'} must actually be hello: \'world\' or use two sets of quotes {hello: "'super world'"} which will keep white space the same

superagent-cli can also add basic HTTP Auth to any request with with -u username:password

superagent -u username:password localhost:3000

superagent-cli can read json data from a file using the -f parameter.

superagent example.com/test post -f request_body.json

superagent-cli can set arbitrary headers with -H

superagent -H "Accept: text/plain, X-Arbitrary-Header: true" example.com

superagent-cli's Issues

Double logging on some responses

It's logging out twice on certain responses. It appears to be on errors (cannot GET route) and sending back a string.

needs ability to set headers

should be -v instead of -d

so say you

JSON object literal notation doesn't like periods

Using the straight object notation to send JSON will cause it to throw an error if your strings include a period. e.g. trying to send a website or email address.

Superagent doesn't write back with strings

res.write(insert string here) does not work. Returns an empty object and undefined.

Logs out responses twice

When a response comes back it's logging the the same message twice across two lines.

auth not working

getting a parsing error

add a timeout to requests

errors out when using single quote JSON with spaces

will error out when posting value with spaces {name: 'Name Guy'}

using single quotes around json causes element value to have spaces stripped

This input to a post: '{"name" : "test name update"}' will strip out the space in the value.

I need to send headers for authentification...how can i do that?

please add support for : within json value

Can't add URLs via superagent-cli because the : character breaks the command line parser.

For example: {"websiteUrl": "http://foo.com"} generates an unexpected token error and points to the : character.