Repository files navigation

This project is now archived. If you want to use Hoppscotch as a CLI client for CI/CD purposes, please use the newHoppscotch CLI.

⚠️⚠️⚠️⚠️⚠️⚠️

Send HTTP requests from terminal and Generate API Docs. An alternative to cURL, httpie ⚡️

$ sh -c"$(curl -sL https://git.io/getpwcli)"

• Clone the repo

$ git clone https://github.com/hoppscotch/hopp-cli.git

• Build and install

$ make$ sudo make install

• You can download prebuilt binaries from theReleases page.
• Supported platforms:
  • Linux (x64, x86)
  • Mac (x64)
  • Windows (x64, x86)

IMPORTANT: Not tested on Windows, please leave your feedback/bugs in the Issues section

• You can install fromAUR
• There are three different packages available

Install by

brew install athul/tap/hopp-cli

You can download pre-built binaries from theReleases page.

Alternatively, you can installhopp-cli viaScoop:

scoop install hopp-cli

Putting Simply:Just pass the URL to the request method

• GET :$ hopp-cli get <url>
• POST:$ hopp-cli post <url>
• PATCH:$ hopp-cli patch <url>
• PUT :$ hopp-cli put <url>
• DELETE:$ hopp-cli delete <url>

Example for a POST request:

$ hopp-cli post https://reqres.in/api/users/2 -c js -b'{"name": "morp","job": "zion resident"}'

• send for testing multiple endpoints
• gen for generating API docs from Collection

This can be used to test multiple endpoints from thehoppscotch-collection.json file.

The output will only be thestatuscode

Example:

$ hopp-cli send<PATH to hoppscotch-collection.json>

Sample output:

Thegen command generates the API documentation fromhoppscotch-collection.json file and serves it as a static page on port1341.

Example:

$ hopp-cli gen<PATH to hoppscotch-collection.json>

Sample Hosted site:https://hopp-docsify.surge.sh/

Powered byDoscify

Flags:

• browser orb to toggle whether the browser should open automatically [Boolean]
• port orp for specifying the port where the server should listen to [Integer]

(optional)

• -t or--token for a Bearer Token for Authentication
• -u for theUsername in Basic Auth
• -p for thepassword in Basic Auth

• -c or--ctype for theContent Type
• -b or--body for the Data Body, this can be of json, html or plain text based on the request.

Enclose the body in Single Quotes(')

Content Types can be of

• -H or--header may be specified multiple times to include headers with the request.

Example:

$ hopp-cli get -H'X-Api-Key: foobar' -H'X-Api-Secret: super_secret' https://example.com/api/v1/accounts

In addition to-b/--body, you may provide a request body via stdin.
If you combine this method with the-b flag, the body provided with-b will be ignored.

Example with Pipes

$echo'{"foo":"bar"}'| hopp-cli post -c js http://example.com

Example with Redirection

$ cat myrequest.json{"foo":"bar"}$ hopp-cli post -c js http://example.com<myrequest.json

In addition to providing request body via-b / --body flag and stdin,you can also use-e / --editor flag which opens default text-editor in your system.

Example:

$ hopp-cli post https://reqres.in/api/users/2 -c js -e

It will preferrably open editor based on$EDITOR environment variable.

For example:If the environment variable is$EDITOR=code it will open VSCode for request-body input. Else, it will use default editor value based on the OS.