Skip to content
This repository has been archived by the owner on Sep 27, 2021. It is now read-only.
/ hopp-cli Public archive

A CLI to run Hoppscotch test scripts in CI environments.

License

Notifications You must be signed in to change notification settings

gitaalekhyapaul/hopp-cli

Repository files navigation

This was a part of my proposal for GitHub Externship 1.0

Hoppscotch CLI

A CLI to run Hoppscotch test scripts in CI environments.

Preview of the CLI:

Demo Video

Commands Available:

Usage: hopp-cli [options or commands] arguments

Options:
  -v, --ver            see the current version of the CLI
  -c, --config <file>  path to a Hoppscotch collection.json file for CI testing
  -h, --help           display help for command

Commands:
  test                 interactive Hoppscotch testing through CLI

Command Descriptions:

  1. hopp-cli -v / hopp-cli --ver

    • Prints out the current version of the Hoppscotch CLI
  2. hopp-cli -c <config> / hopp-cli --config <config>

    • Takes an absolute path of the Hoppscotch config JSON
    • Parses the collection JSON and executes each requests
    • Outputs the response of each request
    • (FUTURE SCOPE): Execute the pre-request and post-request scripts on each request
  3. hopp-cli -h / hopp-cli --help

    • Displays the help text
  4. hopp-cli test

    • Interactive CLI to accept Hoppscotch collection JSON path
    • Parses the collection JSON and executes each requests
    • Outputs the response of each request
    • (FUTURE SCOPE): Execute the pre-request and post-request scripts on each request

Installation:

  1. Clone the repository
  2. yarn
  3. yarn build
  4. yarn link
  5. Test the installation by executing hopp-cli

Contributing:

To get started contributing to the repository, please read CONTRIBUTING.md

About

A CLI to run Hoppscotch test scripts in CI environments.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published