Skip to content

Commit

Permalink
basic CLI instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Coby Tamayo committed Nov 18, 2019
1 parent 6ef94ef commit c2b0e8b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cmd>` or `bin/gearlab <cmd> -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:
Expand Down

0 comments on commit c2b0e8b

Please # to comment.