Inso readme (#2360)

* Add command readme

* Add to readme

* add demo

* Update README.md

* Readme

* Readme

* Readme

* Readme

* Update README.md

* Update README.md

packages/insomnia-inso/.npmignore

@@ -5,3 +5,4 @@
 
 # Don't ignore dist folder
 !dist/*
+!assets/*

packages/insomnia-inso/README.md

@@ -1,14 +1,125 @@
-# insomnia-inso
+# `inso`
 
-This is the CLI for Insomnia.
+A CLI to accompany <a href="https://insomnia.rest">Insomnia Designer</a>
+
+<div align="center">
+  <pre>npm i -g <a href="https://www.npmjs.com/package/insomnia-inso">insomnia-inso</a></pre>
+</div>
+
+---
+
+## Data source
+
+`inso` will first try to find a `.insomnia` directory in it's working directory. This directory is generated in a git repository when using git sync in Designer. When `inso` is used in a CI environment, it will always run against the `.insomnia` directory.
+
+If `inso` cannot find the `.insomnia` directory, it will try to run against the Designer app data directory (if found). You can override both the working directory, and the app data directory, using the `--working-dir` and `--app-data-dir` global options.
+
+## The `[identifier]` argument
+
+Typically, Insomnia database id's are quite long, for example: `wrk_012d4860c7da418a85ffea7406e1292a`. When specifying an identifier for `inso`, similar to Git hashes, you may choose to concatenate and use the first x characters (for example, `wrk_012d486` ), which is very likely to be unique. If in the rare chance the short id is _not_ unique against the data, `inso` will inform as such.
+
+Additionally, if the `[identifier]` argument is ommitted from the command, `inso` will search in the database for the information it needs, and prompt the user. Prompts can be disabled with the `--ci` global option.
+
+![](/packages/insomnia-inso/assets/ci-demo.gif)
+
+## Commands
+
+### `$ inso [global options] [command]`
+
+|Global option|Alias|Description|
+|- |- |- |
+| `--working-dir <dir>` | `-w` |set working directory|
+| `--app-data-dir <dir>` | `-a` |set the app data directory|
+| `--ci` | | run in CI, disables all prompts |
+| `--version` | `-v` |output the version number|
+| `--help` | `-h` |display help for a command|
+
+### `$ inso generate config [options] [identifier]`
+
+Similar to the Kong [Kubernetes](https://insomnia.rest/plugins/insomnia-plugin-kong-kubernetes-config) and [Declarative](https://insomnia.rest/plugins/insomnia-plugin-kong-declarative-config) config plugins for Designer, this command can generate configuration from an API specification, using [openapi-2-kong](https://www.npmjs.com/package/openapi-2-kong).
+
+**`[identifier]`**: this can be a **document name, id, or a file path** relative to the working directory.
+
+|Option|Alias|Description|
+|- |- |- |
+| `--type <type>` | `-t` |type of configuration to generate, options are `kubernetes` and `declarative` (default: `declarative` ) |
+| `--output <path>` | `-o` |save the generated config to a file in the working directory|
+
+#### Examples
+
+When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory
 
-### Usage
 ```
-npm install -g insomnia-inso
-inso --version
+inso generate config
+
+inso generate config spc_46c5a4 --type declarative
+
+inso generate config spc_46c5a4 --type declarative > output.yaml
+
+inso generate config "Sample Specification" --output output.yaml
+
+inso generate config "Sample Specification" --type kubernetes
+
+inso generate config spec.yaml --working-dir another/dir
 ```
 
-### Development
-- Bootstrap: `npm run bootstrap`
-- Start the compiler in watch mode: `npm run watch`
-- Run: `./bin/inso -v`
+### `$ inso lint spec [identifier]`
+
+Designer has the ability to lint and validate your OpenAPI specification as you write it. This command adds the same functionality to `inso` , in order to run linting during CI workflows. Lint results will be printed to the console, and `inso` will exit with an appropriate exit code.
+
+**`[identifier]`**: this can be a **document name, or id**.
+
+#### Examples
+
+When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory
+
+```
+inso lint spec
+
+inso lint spec spc_46c5a4
+
+inso lint spec "Sample Specification"
+```
+
+### `$ inso run test [options] [identifier]`
+
+API Unit Testing was introduced with Designer 2020.3.0, and this command adds the functionality to execute those unit tests via the command line, very useful for a CI environment. `inso` will report on test results, and exit with an appropriate exit code.
+
+**`[identifier]`**: this can be the **name or id** of a **workspace, document, or unit test suite**.
+
+The test runner is built on top of Mocha, thus many of the options behave as they would in Mocha. The options currently supported are:
+
+|Option|Alias|Description|
+|- |- |- |
+| `--env <identifier>` | `-e` |the environment to use - an environment name or id |
+| `--reporter <value>` | `-r` |reporter to use, options are `dot, list, spec, min and progress` (default: `spec` )|
+| `--test-name-pattern <regex>` | `-t` | run tests that match the regex|
+| `--bail` | `-b` | abort ("bail") after the first test failure|
+| `--keep-file` | | do not delete the generated test file (useful for debugging)|
+
+#### Examples
+
+When running in the [git-repo](/packages/insomnia-inso/src/db/__fixtures__/git-repo) directory.
+
+```
+inso run test
+
+# By document
+inso run test "Sample Specification" --env "OpenAPI env"
+inso run test spc_46c5a4 --env env_env_ca046a
+
+# By suite
+inso run test "Math Suite" --env "OpenAPI env"
+inso run test uts-7f0f85 --env env_env_ca046a
+
+inso run test "Sample Specification" --test-name-pattern Math --env env_env_ca046a
+inso run test spc_46c5a4 --reporter progress --bail --keep-file
+```
+
+More examples: [#2338](https://github.com/Kong/insomnia/pull/2338).
+
+## Development
+
+* Bootstrap: `npm run bootstrap`
+* Start the compiler in watch mode: `npm run watch`
+* Run: `./bin/inso -v`