From c2b0e8b5363a7ffc58b6a4cfb7a7e71f2b0859f6 Mon Sep 17 00:00:00 2001 From: Coby Tamayo Date: Mon, 18 Nov 2019 14:30:45 -0800 Subject: [PATCH] basic CLI instructions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5aa8536..bbcf7b7 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,16 @@ array ( ) ``` +## Command Line Interface + +With just an API key and a Collection ID, you can perform requests to the API from the command line. Assuming you've cloned the repo and run `composer install`, you can run the following from the repo root: + +``` +bin/gearlab +``` + +This will display help text for all available subcommands of the CLI. You can also get help for any subcommand by running `bin/gearlab help ` or `bin/gearlab -h`. + ## Architecture This package incorporates PHP code that is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project from the [GearLab Tool API Spec](https://app.swaggerhub.com/apis-docs/ctamayo/gearlab-tools/v2). The generated code is exported automatically when the spec is saved in Swagger Hub, and is contained entirely in the `swagger/SwaggerClient-php` directory within this repo. The Composer autoloader is configured to autoload this code: