feat(portal): adds portal quickstart and serve commands (#33)

Implements a part of #10 .

What was Added?

Added the portal:quickstart command for helping new users get started with APIMatic Docs-as-Code solution.
Added the portal:serve command to allow serving of static portals generated using Docs-as-Code locally.

Author: aliasghar98

.github/workflows/check_build.yml

@@ -18,14 +18,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '14', '18' ]
+        node: [ '14', '18', '20' ]
     name: Node ${{ matrix.node }} sample
     steps:
       - name: checkout cli
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: apimatic/apimatic-cli
-          token: ${{ secrets.ACCESS_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
           persist-credentials: false
           fetch-depth: 0
           path: cli
@@ -35,9 +35,7 @@ jobs:
 
       - name: Install dependencies
         working-directory: cli
-        run: |
-          git config --global url."https://${{ secrets.ACCESS_TOKEN }}@github.com/".insteadOf https://github.com/
-          npm install
+        run: npm install
 
       - name: Check Build
         working-directory: 'cli'

.github/workflows/npm-tag-latest.yml

@@ -13,6 +13,6 @@ jobs:
     steps:
       - name: change-latest-tag
         env:
-          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npm dist-tag add @apimatic/cli@${LATEST_VERSION} latest

.github/workflows/release.yml

@@ -9,14 +9,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '18' ]
+        node: [ '20' ]
     name: Release with Node version ${{ matrix.node }}
     steps:
       - name: Checkout CLI
         uses: actions/checkout@v2
         with:
           repository: apimatic/apimatic-cli
-          token: ${{ secrets.ACCESS_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
           persist-credentials: false
           fetch-depth: 0
           path: cli
@@ -27,7 +27,6 @@ jobs:
       - name: Install dependencies
         working-directory: cli
         run: |
-          git config --global url."https://${{ secrets.ACCESS_TOKEN }}@github.com/".insteadOf https://github.com/
           npm install
           npm install --save-dev @semantic-release/changelog @semantic-release/git
       - name: Check Build
@@ -37,6 +36,6 @@ jobs:
       - name: Release
         working-directory: cli
         env:
-          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release

README.md

@@ -1,5 +1,6 @@
 @apimatic/cli
 =============
+apimatic is in Alpha.
 
 The official CLI for APIMatic.
 
@@ -8,18 +9,26 @@ The official CLI for APIMatic.
 [![Downloads/week](https://img.shields.io/npm/dw/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
 [![License](https://img.shields.io/npm/l/@apimatic/cli.svg)](https://github.com/apimatic/apimatic-cli/blob/master/package.json)
 
+# Getting Started
+
+To get started with APIMatic's CLI using a step by step wizard, run the following command: 
+
+```sh-session
+$ apimatic portal:quickstart
+```
+
 <!-- toc -->
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
 # Usage
 <!-- usage -->
 ```sh-session
-$ npm install -g @apimatic/cli@1.0.1-alpha.3
+$ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
-$ apimatic (-v|--version|version)
-@apimatic/cli/0.0.0-alpha.3 linux-x64 node-v16.13.0
+$ apimatic (--version)
+@apimatic/cli/0.0.0-alpha.0 win32-x64 node-v20.18.3
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
@@ -37,6 +46,8 @@ USAGE
 * [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
 * [`apimatic help [COMMAND]`](#apimatic-help-command)
 * [`apimatic portal:generate`](#apimatic-portalgenerate)
+* [`apimatic portal:quickstart`](#apimatic-portalquickstart)
+* [`apimatic portal:serve`](#apimatic-portalserve)
 * [`apimatic sdk:generate`](#apimatic-sdkgenerate)
 
 ## `apimatic api:transform`
@@ -45,9 +56,10 @@ Transform API specifications from one format to another. Supports [10+ different
 
 ```
 USAGE
-  $ apimatic api:transform
+  $ apimatic api:transform --format <value> [--file <value>] [--url <value>] [--destination <value>] [-f]
+    [--auth-key <value>]
 
-OPTIONS
+FLAGS
   -f, --force                overwrite if same file exist in the destination
   --auth-key=auth-key        override current authentication state with an authentication key
 
@@ -63,6 +75,11 @@ OPTIONS
   --url=url                  URL to the API specification file to transform. Can be used in place of the --file option
                              if the API specification is publicly available.
 
+DESCRIPTION
+  Transform API specifications from one format to another. Supports [10+ different
+  formats](https://www.apimatic.io/transformer/#supported-formats) including OpenApi/Swagger, RAML, WSDL and Postman
+  Collections.
+
 EXAMPLES
   $ apimatic api:transform --format="OpenApi3Json" --file="./specs/sample.json" --destination="D:/"
   Success! Your transformed file is located at D:/Transformed_OpenApi3Json.json
@@ -71,23 +88,26 @@ EXAMPLES
   Success! Your transformed file is located at D:/swagger_raml.yaml
 ```
 
-_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/api/transform.ts)_
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/api/transform.ts)_
 
 ## `apimatic api:validate`
 
 Validate the syntactic and semantic correctness of an API specification
 
 ```
 USAGE
-  $ apimatic api:validate
+  $ apimatic api:validate [--file <value>] [--url <value>] [--auth-key <value>]
 
-OPTIONS
+FLAGS
   --auth-key=auth-key  override current authentication state with an authentication key
   --file=file          Path to the API specification file to validate
 
   --url=url            URL to the specification file to validate. Can be used in place of the --file option if the API
                        specification is publicly available.
 
+DESCRIPTION
+  Validate the syntactic and semantic correctness of an API specification
+
 EXAMPLES
   $ apimatic api:validate --file="./specs/sample.json"
   Specification file provided is valid
@@ -96,19 +116,22 @@ EXAMPLES
   Specification file provided is valid
 ```
 
-_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/api/validate.ts)_
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/api/validate.ts)_
 
 ## `apimatic auth:login`
 
 Login using your APIMatic credentials or an API Key
 
 ```
 USAGE
-  $ apimatic auth:login
+  $ apimatic auth:login [--auth-key <value>]
 
-OPTIONS
+FLAGS
   --auth-key=auth-key  Set authentication key for all commands
 
+DESCRIPTION
+  Login using your APIMatic credentials or an API Key
+
 EXAMPLES
   $ apimatic auth:login
   Please enter your registered email: apimatic-user@gmail.com
@@ -120,7 +143,7 @@ EXAMPLES
   Authentication key successfully set
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/login.ts)_
 
 ## `apimatic auth:logout`
 
@@ -130,12 +153,15 @@ Clear local login credentials
 USAGE
   $ apimatic auth:logout
 
-EXAMPLE
+DESCRIPTION
+  Clear local login credentials
+
+EXAMPLES
   $ apimatic auth:logout
   Logged out
 ```
 
-_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/logout.ts)_
 
 ## `apimatic auth:status`
 
@@ -145,39 +171,45 @@ View current authentication state
 USAGE
   $ apimatic auth:status
 
-EXAMPLE
+DESCRIPTION
+  View current authentication state
+
+EXAMPLES
   $ apimatic auth:status
   Currently logged in as apimatic-client@gmail.com
 ```
 
-_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/status.ts)_
 
 ## `apimatic autocomplete [SHELL]`
 
-display autocomplete installation instructions
+Display autocomplete installation instructions.
 
 ```
 USAGE
-  $ apimatic autocomplete [SHELL]
+  $ apimatic autocomplete [SHELL] [-r]
 
 ARGUMENTS
   SHELL  shell type
 
-OPTIONS
+FLAGS
   -r, --refresh-cache  Refresh cache (ignores displaying instructions)
 
+DESCRIPTION
+  Display autocomplete installation instructions.
+
 EXAMPLES
   $ apimatic autocomplete
   $ apimatic autocomplete bash
   $ apimatic autocomplete zsh
   $ apimatic autocomplete --refresh-cache
 ```
 
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/main/src/commands/autocomplete/index.ts)_
 
 ## `apimatic help [COMMAND]`
 
-display help for apimatic
+Display help for apimatic.
 
 ```
 USAGE
@@ -186,43 +218,87 @@ USAGE
 ARGUMENTS
   COMMAND  command to show help for
 
-OPTIONS
-  --all  see all commands in CLI
+DESCRIPTION
+  Display help for apimatic.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.14/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/main/src/commands/help.ts)_
 
 ## `apimatic portal:generate`
 
-Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://portal-api-docs.apimatic.io/#/http/generating-api-portal/build-file)
+Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
 
 ```
 USAGE
-  $ apimatic portal:generate
+  $ apimatic portal:generate [--folder <value>] [--destination <value>] [-f] [--zip] [--auth-key <value>]
 
-OPTIONS
+FLAGS
   -f, --force                overwrite if a portal exists in the destination
-  --auth-key=auth-key        override current authentication state with an authentication key
-  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] path to the downloaded portal
-  --folder=folder            [default: ./] path to the input directory containing API specifications and config files
-  --zip                      download the generated portal as a .zip archive
+DESCRIPTION
+  Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a
+  config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platfo
+  rm-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
 
-EXAMPLE
+EXAMPLES
   $ apimatic portal:generate --folder="./portal/" --destination="D:/"
   Your portal has been generated at D:/
 ```
 
-_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/portal/generate.ts)_
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/generate.ts)_
+
+## `apimatic portal:quickstart`
+
+Create your first API Portal using APIMatic’s Docs as Code offering.
+
+```
+USAGE
+  $ apimatic portal:quickstart
+
+DESCRIPTION
+  Create your first API Portal using APIMatic’s Docs as Code offering.
+
+EXAMPLES
+  $ apimatic portal:quickstart
+```
+
+_See code: [src/commands/portal/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.11/src/commands/portal/quickstart.ts)_
+
+## `apimatic portal:serve`
+
+Generate and deploy a Docs as Code portal with hot reload.
+
+```
+USAGE
+  $ apimatic portal:serve [-p <value>] [-d <value>] [-s <value>] [-o] [--no-reload] [-i <value>] [--auth-key <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: ./api-portal] Directory to store and serve the generated portal.
+  -i, --ignore=<value>       Comma-separated list of files/directories to ignore.
+  -o, --open                 Open the portal in the default browser.
+  -p, --port=<value>         [default: 3000] Port to serve the portal.
+  -s, --source=<value>       [default: ./] Source directory containing specs, content, and build file. By default, the
+                             current directory is used.
+      --auth-key=<value>     Override current authentication state with an authentication key.
+      --no-reload            Disable hot reload.
+
+DESCRIPTION
+  Generate and deploy a Docs as Code portal with hot reload.
+
+EXAMPLES
+  $ apimatic portal:serve --source="./" --destination="./api-portal" --port=3000 --open --no-reload
+```
+
+_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.11/src/commands/portal/serve.ts)_
 
 ## `apimatic sdk:generate`
 
 Generate SDK for your APIs
 
 ```
 USAGE
-  $ apimatic sdk:generate
+  $ apimatic sdk:generate --platform <value> [--file <value>] [--url <value>] [--destination <value>] [-f] [--zip] [--auth-key <value>]
 
-OPTIONS
+FLAGS
   -f, --force                overwrite if an SDK already exists in the destination
   --auth-key=auth-key        override current authentication state with an authentication key
 
@@ -239,8 +315,10 @@ OPTIONS
 
   --url=url                  URL to the API specification to generate SDKs for. Can be used in place of the --file
                              option if the API specification is publicly available.
+      --zip                  download the generated SDK as a .zip archive
 
-  --zip                      download the generated SDK as a .zip archive
+DESCRIPTION
+  Generate SDK for your APIs
 
 EXAMPLES
   $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
@@ -254,5 +332,5 @@ EXAMPLES
   Success! Your SDK is located at swagger_sdk_csharp
 ```
 
-_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/sdk/generate.ts)_
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/sdk/generate.ts)_
 <!-- commandsstop -->