From 58d8e61f65054127924b0d5b1449082d969ccb06 Mon Sep 17 00:00:00 2001
From: saeedjamshaid <muhammad.saeed@apimatic.io>
Date: Mon, 26 Oct 2026 16:55:25 +0500
Subject: [PATCH 1/4] docs: store README.md with LF line endings

oclif readme can't find its usage and commands blocks in a CRLF file, so it
added a second copy of each instead of replacing them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---
 .gitattributes |   1 +
 README.md      | 990 ++++++++++++++++++++++++-------------------------
 2 files changed, 496 insertions(+), 495 deletions(-)
 create mode 100644 .gitattributes

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 000000000..07142a065
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+/README.md text eol=lf
diff --git a/README.md b/README.md
index 063fd949b..ec3f95499 100644
--- a/README.md
+++ b/README.md
@@ -1,495 +1,495 @@
-@apimatic/cli
-=============
-
-The official CLI for APIMatic.
-
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
-[![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)
-
-# Requirements
-
-Node.js 24 or newer, for every command. npm only warns when your Node is older, so the
-install succeeds and the CLI then refuses to run, naming the version it found.
-
-# Getting Started
-
-To get started with APIMatic's CLI using a step by step wizard, run the following command: 
-
-```sh-session
-$ apimatic quickstart
-```
-
-# Usage
-<!-- usage -->
-```sh-session
-$ npm install -g @apimatic/cli
-$ apimatic COMMAND
-running command...
-$ apimatic (--version)
-@apimatic/cli/1.3.1 win32-x64 node-v24.19.0
-$ apimatic --help [COMMAND]
-USAGE
-  $ apimatic COMMAND
-...
-```
-<!-- usagestop -->
-
-# Commands
-<!-- commands -->
-* [`apimatic api transform`](#apimatic-api-transform)
-* [`apimatic api validate`](#apimatic-api-validate)
-* [`apimatic auth login`](#apimatic-auth-login)
-* [`apimatic auth logout`](#apimatic-auth-logout)
-* [`apimatic auth status`](#apimatic-auth-status)
-* [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
-* [`apimatic help [COMMAND]`](#apimatic-help-command)
-* [`apimatic plugin generate`](#apimatic-plugin-generate)
-* [`apimatic plugin publish`](#apimatic-plugin-publish)
-* [`apimatic portal generate`](#apimatic-portal-generate)
-* [`apimatic portal serve`](#apimatic-portal-serve)
-* [`apimatic publishing profile list`](#apimatic-publishing-profile-list)
-* [`apimatic quickstart`](#apimatic-quickstart)
-* [`apimatic sdk generate`](#apimatic-sdk-generate)
-* [`apimatic sdk publish`](#apimatic-sdk-publish)
-
-## `apimatic api transform`
-
-Transform API specifications between different formats
-
-```
-USAGE
-  $ apimatic api transform --format
-    apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apiblueprint|raml|raml10|postman10|postman2
-    0|graphqlschema [--file <value>] [--url <value>] [-d <value>] [-f] [-k <value>]
-
-FLAGS
-  -d, --destination=<value>  [default: ./] Directory to save the transformed file to
-  -f, --force                overwrite changes without asking for user consent.
-  -k, --auth-key=<value>     override current authentication state with an authentication key.
-      --file=<value>         Path to the API specification file to transform
-      --format=<option>      (required) Specification format to transform API specification into
-                             <options: apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apibluep
-                             rint|raml|raml10|postman10|postman20|graphqlschema>
-      --url=<value>          URL to the API specification file to transform (publicly accessible)
-
-DESCRIPTION
-  Transform API specifications between different formats
-
-  Transform API specifications from one format to another.
-  Supports multiple formats including OpenAPI/Swagger, RAML, WSDL, and Postman Collections.
-
-EXAMPLES
-  apimatic api transform --format=openapi3yaml --file=./specs/sample.json --destination=./
-
-  apimatic api transform --format=raml --url="https://petstore.swagger.io/v2/swagger.json" --destination=./
-```
-
-_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/transform.ts)_
-
-## `apimatic api validate`
-
-Validate API specification for syntactic and semantic correctness
-
-```
-USAGE
-  $ apimatic api validate [--file <value> | --url <value> | -i <value>] [-k <value>]
-
-FLAGS
-  -i, --input=<value>     [default: ./] path to the parent directory containing the 'src' directory, which includes API
-                          specifications and configuration files.
-  -k, --auth-key=<value>  override current authentication state with an authentication key.
-      --file=<value>      Path to the API specification file to validate
-      --url=<value>       URL to the API specification file to validate (publicly accessible)
-
-DESCRIPTION
-  Validate API specification for syntactic and semantic correctness
-
-  Validate the API specification in your 'src/spec' directory, or the one --file or --url points to, to ensure it
-  adheres to syntactic and semantic standards.
-
-EXAMPLES
-  apimatic api validate
-
-  apimatic api validate --input=./
-
-  apimatic api validate --file=./specs/sample.json
-
-  apimatic api validate --url="https://petstore.swagger.io/v2/swagger.json"
-```
-
-_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/validate.ts)_
-
-## `apimatic auth login`
-
-Login to your APIMatic account
-
-```
-USAGE
-  $ apimatic auth login [-k <value>]
-
-FLAGS
-  -k, --auth-key=<value>  Sets authentication key for all commands.
-
-DESCRIPTION
-  Login to your APIMatic account
-
-  Login using your APIMatic credentials or an API Key
-
-EXAMPLES
-  apimatic auth login
-
-  apimatic auth login --auth-key={api-key}
-```
-
-_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/login.ts)_
-
-## `apimatic auth logout`
-
-Clears the local login credentials.
-
-```
-USAGE
-  $ apimatic auth logout
-
-DESCRIPTION
-  Clears the local login credentials.
-
-  Clears the local login credentials. This will also clear any cached credentials from the CLI.
-
-EXAMPLES
-  apimatic auth logout
-```
-
-_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/logout.ts)_
-
-## `apimatic auth status`
-
-View the currently logged in user.
-
-```
-USAGE
-  $ apimatic auth status
-
-DESCRIPTION
-  View the currently logged in user.
-
-EXAMPLES
-  apimatic auth status
-```
-
-_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/status.ts)_
-
-## `apimatic autocomplete [SHELL]`
-
-Display autocomplete installation instructions.
-
-```
-USAGE
-  $ apimatic autocomplete [SHELL] [-r]
-
-ARGUMENTS
-  [SHELL]  (zsh|bash|powershell) Shell type
-
-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 powershell
-
-  $ apimatic autocomplete --refresh-cache
-```
-
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.47/src/commands/autocomplete/index.ts)_
-
-## `apimatic help [COMMAND]`
-
-Display help for apimatic.
-
-```
-USAGE
-  $ apimatic help [COMMAND...] [-n]
-
-ARGUMENTS
-  [COMMAND...]  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for apimatic.
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.46/src/commands/help.ts)_
-
-## `apimatic plugin generate`
-
-Generate a context plugin for your SDKs.
-
-```
-USAGE
-  $ apimatic plugin generate [-i <value>] [-d <value>] [-f] [-k <value>]
-
-FLAGS
-  -d, --destination=<value>  [default: <input>/plugin] path where the plugin will be generated.
-  -f, --force                overwrite changes without asking for user consent.
-  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
-                             API specifications and configuration files.
-  -k, --auth-key=<value>     override current authentication state with an authentication key.
-
-DESCRIPTION
-  Generate a context plugin for your SDKs.
-
-  Generate a context plugin that teaches an AI coding assistant how to use your SDKs. Requires an input directory
-  containing a `src` directory with your API specification — `apimatic.json` is created if it is not there. It asks
-  for the plugin's name on the first run, and for its languages only when `apimatic.json` records none (`sdk publish`
-  records them). Later runs read both from `apimatic.json` without asking.
-
-EXAMPLES
-  apimatic plugin generate
-
-  apimatic plugin generate --input="./" --destination="./plugin"
-```
-
-_See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/generate.ts)_
-
-## `apimatic plugin publish`
-
-Print the git commands for publishing your context plugin to GitHub.
-
-```
-USAGE
-  $ apimatic plugin publish [-i <value>] [-d <value>]
-
-FLAGS
-  -d, --destination=<value>  [default: <input>/plugin] path where the plugin was generated.
-  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
-                             API specifications and configuration files.
-
-DESCRIPTION
-  Print the git commands for publishing your context plugin to GitHub.
-
-  Print the commands that publish a generated context plugin to a GitHub repository. The commands are printed for you to
-  run — this command never touches your repository.
-
-EXAMPLES
-  apimatic plugin publish
-
-  apimatic plugin publish --input="./" --destination="./plugin"
-```
-
-_See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/publish.ts)_
-
-## `apimatic portal generate`
-
-Generate a static API Documentation Portal.
-
-```
-USAGE
-  $ apimatic portal generate [--zip] [-i <value>] [-d <value>] [-f] [-k <value>]
-
-FLAGS
-  -d, --destination=<value>  [default: <input>/portal] path where the portal will be generated.
-  -f, --force                overwrite changes without asking for user consent.
-  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
-                             API specifications and configuration files.
-  -k, --auth-key=<value>     override current authentication state with an authentication key.
-      --zip                  write the generated portal as a .zip archive.
-
-DESCRIPTION
-  Generate a static API Documentation Portal.
-
-  Builds a documentation portal from the OpenAPI documents and Markdown pages in your 'src' directory.
-
-  Each OpenAPI document at the top of 'src/spec' gets a section of the API reference, and the SDKs are built from one of
-  them. To build the SDKs from several, put each in a folder of its own and set 'MergeConfiguration.MergeApis' to true
-  in an 'APIMATIC-META.json' beside the folders; each folder then gets a section.
-
-  The portal is built on your machine and written as static files for any static host, served at its root or, when
-  'portal.site.url' has a path such as 'https://example.com/docs', at that path. Configure it with 'src/apimatic.json',
-  whose 'languages' block gives the portal a page for each SDK language, and whose 'plugin' block, or a 'pluginUrl' in
-  its 'portal' block for a plugin hosted elsewhere, a page for the context plugin.
-
-EXAMPLES
-  apimatic portal generate
-
-  apimatic portal generate --input=./ --destination=./portal
-
-  apimatic portal generate --zip
-```
-
-_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/generate.ts)_
-
-## `apimatic portal serve`
-
-Preview your API Documentation Portal with live reload.
-
-```
-USAGE
-  $ apimatic portal serve [-p 23513] [-o] [-i <value>] [-k <value>]
-
-FLAGS
-  -i, --input=<value>     [default: ./] path to the parent directory containing the 'src' directory, which includes API
-                          specifications and configuration files.
-  -k, --auth-key=<value>  override current authentication state with an authentication key.
-  -o, --open              open the portal in the default browser.
-  -p, --port=23513        [default: 23513] port to serve the portal on.
-
-DESCRIPTION
-  Preview your API Documentation Portal with live reload.
-
-  Serves the portal described by 'src/apimatic.json' from your machine, reloading the browser as you edit the Markdown
-  pages in 'src/content', reorder them in a 'nav.json', edit the documents in 'src/spec', or change the 'portal',
-  'languages' or 'plugin' block of 'apimatic.json'.
-
-  Adding a language or a 'plugin' block, adding or removing a page in 'src/content', creating 'src/static', changing
-  which documents are in 'src/spec' or which folders its 'APIMATIC-META.json' merges, or changing the path in
-  'portal.site.url', needs the preview restarted.
-
-  Nothing is written to disk; run 'apimatic portal generate' to produce the static files.
-
-EXAMPLES
-  apimatic portal serve
-
-  apimatic portal serve --input=./ --port=23513 --open
-```
-
-_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/serve.ts)_
-
-## `apimatic publishing profile list`
-
-List all publishing profiles
-
-```
-USAGE
-  $ apimatic publishing profile list
-
-DESCRIPTION
-  List all publishing profiles
-
-  Display all publishing profiles associated with your account, including each profile's name, ID and enabled languages.
-
-EXAMPLES
-  apimatic publishing profile list
-```
-
-_See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/publishing/profile/list.ts)_
-
-## `apimatic quickstart`
-
-Create your API Documentation Portal, SDKs and Context Plugins.
-
-```
-USAGE
-  $ apimatic quickstart
-
-DESCRIPTION
-  Create your API Documentation Portal, SDKs and Context Plugins.
-
-  Point the CLI at your API specification and it builds a documentation portal, SDKs, and a context plugin that teaches
-  an AI coding assistant to use them.
-
-EXAMPLES
-  apimatic quickstart
-```
-
-_See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/quickstart.ts)_
-
-## `apimatic sdk generate`
-
-Generate an SDK for your API
-
-```
-USAGE
-  $ apimatic sdk generate -l csharp|java|php|python|ruby|typescript|go [-d <value>] [--api-version <value>]
-    [--zip] [--codegen-version v4] [--stability stable|beta] [-i <value>] [-f] [-k <value>]
-
-FLAGS
-  -d, --destination=<value>       [default: <input>/sdk/<language> | <input>/sdk/<api-version>/<language>] path where
-                                  the SDK will be generated
-  -f, --force                     overwrite changes without asking for user consent.
-  -i, --input=<value>             [default: ./] path to the parent directory containing the 'src' directory, which
-                                  includes API specifications and configuration files.
-  -k, --auth-key=<value>          override current authentication state with an authentication key.
-  -l, --language=<option>         (required) Programming language for SDK generation
-                                  <options: csharp|java|php|python|ruby|typescript|go>
-      --api-version=<value>       Version of the API to use for SDK generation (if multiple versions exist)
-      --codegen-version=<option>  [default: v4] Version of the code generator to use
-                                  <options: v4>
-      --stability=<option>        Stability level of the generated SDK. Defaults to the level the language offers.
-                                  <options: stable|beta>
-      --zip                       Download the generated SDK as a .zip archive
-
-DESCRIPTION
-  Generate an SDK for your API
-
-  Generate a Software Development Kit (SDK) from an API specification.
-  C#, TypeScript and Python are available; Java, Ruby, Go and PHP are coming soon.
-
-EXAMPLES
-  apimatic sdk generate --language=typescript
-
-  apimatic sdk generate --language=csharp --input=./
-
-  apimatic sdk generate --language=python --destination=./sdk --zip
-```
-
-_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/generate.ts)_
-
-## `apimatic sdk publish`
-
-Generate and publish an SDK to a package registry and/or source repository
-
-```
-USAGE
-  $ apimatic sdk publish [-p <value>] [-v <value>] [-d <value>] [-l csharp|java|php|python|ruby|typescript|go]
-    [-f] [-i <value>] [--publish-type package|sourcecode...] [--dry-run] [--codegen-version v4] [--stability
-    stable|beta]
-
-FLAGS
-  -d, --destination=<value>       [default: <input>/sdk] path where the sdk will be generated.
-  -f, --force                     overwrite changes without asking for user consent.
-  -i, --input=<value>             [default: ./] path to the parent directory containing the 'src' directory, which
-                                  includes API specifications and configuration files.
-  -l, --language=<option>         Language of the SDK to generate and publish.
-                                  <options: csharp|java|php|python|ruby|typescript|go>
-  -p, --profile-id=<value>        Id of the publishing profile to use.
-  -v, --version=<value>           Semantic version of the SDK to publish (e.g. 1.0.0).
-      --codegen-version=<option>  [default: v4] Version of the code generator to use
-                                  <options: v4>
-      --dry-run                   Generate the SDK locally for review without publishing.
-      --publish-type=<option>...  One or more publishing targets: 'package' for a package registry, 'sourcecode' for a
-                                  git repository.
-                                  <options: package|sourcecode>
-      --stability=<option>        Stability level of the generated SDK. Defaults to the level the language offers.
-                                  <options: stable|beta>
-
-DESCRIPTION
-  Generate and publish an SDK to a package registry and/or source repository
-
-  Generate and publish an SDK using a publishing profile configured in the APIMatic App. Requires an input directory
-  containing the API specification. Run without flags for a step-by-step interactive experience, or pass all required
-  flags for CI/CD automation.
-
-EXAMPLES
-  apimatic sdk publish
-
-  apimatic sdk publish --profile-id=a1b2c3d4e5f6a1b2c3d4e5f6 --language=typescript --version=1.0.0 --publish-type=package --publish-type=sourcecode
-
-  apimatic sdk publish --profile-id=b2c3d4e5f6a1b2c3d4e5f6a1 --language=csharp --version=2.0.0 --publish-type=sourcecode
-
-  apimatic sdk publish --profile-id=c3d4e5f6a1b2c3d4e5f6a1b2 --language=python --version=1.0.0 --publish-type=package --dry-run
-```
-
-_See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/publish.ts)_
-<!-- commandsstop -->
+@apimatic/cli
+=============
+
+The official CLI for APIMatic.
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
+[![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)
+
+# Requirements
+
+Node.js 24 or newer, for every command. npm only warns when your Node is older, so the
+install succeeds and the CLI then refuses to run, naming the version it found.
+
+# Getting Started
+
+To get started with APIMatic's CLI using a step by step wizard, run the following command: 
+
+```sh-session
+$ apimatic quickstart
+```
+
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @apimatic/cli
+$ apimatic COMMAND
+running command...
+$ apimatic (--version)
+@apimatic/cli/1.3.1 win32-x64 node-v24.19.0
+$ apimatic --help [COMMAND]
+USAGE
+  $ apimatic COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+<!-- commands -->
+* [`apimatic api transform`](#apimatic-api-transform)
+* [`apimatic api validate`](#apimatic-api-validate)
+* [`apimatic auth login`](#apimatic-auth-login)
+* [`apimatic auth logout`](#apimatic-auth-logout)
+* [`apimatic auth status`](#apimatic-auth-status)
+* [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
+* [`apimatic help [COMMAND]`](#apimatic-help-command)
+* [`apimatic plugin generate`](#apimatic-plugin-generate)
+* [`apimatic plugin publish`](#apimatic-plugin-publish)
+* [`apimatic portal generate`](#apimatic-portal-generate)
+* [`apimatic portal serve`](#apimatic-portal-serve)
+* [`apimatic publishing profile list`](#apimatic-publishing-profile-list)
+* [`apimatic quickstart`](#apimatic-quickstart)
+* [`apimatic sdk generate`](#apimatic-sdk-generate)
+* [`apimatic sdk publish`](#apimatic-sdk-publish)
+
+## `apimatic api transform`
+
+Transform API specifications between different formats
+
+```
+USAGE
+  $ apimatic api transform --format
+    apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apiblueprint|raml|raml10|postman10|postman2
+    0|graphqlschema [--file <value>] [--url <value>] [-d <value>] [-f] [-k <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: ./] Directory to save the transformed file to
+  -f, --force                overwrite changes without asking for user consent.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
+      --file=<value>         Path to the API specification file to transform
+      --format=<option>      (required) Specification format to transform API specification into
+                             <options: apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apibluep
+                             rint|raml|raml10|postman10|postman20|graphqlschema>
+      --url=<value>          URL to the API specification file to transform (publicly accessible)
+
+DESCRIPTION
+  Transform API specifications between different formats
+
+  Transform API specifications from one format to another.
+  Supports multiple formats including OpenAPI/Swagger, RAML, WSDL, and Postman Collections.
+
+EXAMPLES
+  apimatic api transform --format=openapi3yaml --file=./specs/sample.json --destination=./
+
+  apimatic api transform --format=raml --url="https://petstore.swagger.io/v2/swagger.json" --destination=./
+```
+
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/transform.ts)_
+
+## `apimatic api validate`
+
+Validate API specification for syntactic and semantic correctness
+
+```
+USAGE
+  $ apimatic api validate [--file <value> | --url <value> | -i <value>] [-k <value>]
+
+FLAGS
+  -i, --input=<value>     [default: ./] path to the parent directory containing the 'src' directory, which includes API
+                          specifications and configuration files.
+  -k, --auth-key=<value>  override current authentication state with an authentication key.
+      --file=<value>      Path to the API specification file to validate
+      --url=<value>       URL to the API specification file to validate (publicly accessible)
+
+DESCRIPTION
+  Validate API specification for syntactic and semantic correctness
+
+  Validate the API specification in your 'src/spec' directory, or the one --file or --url points to, to ensure it
+  adheres to syntactic and semantic standards.
+
+EXAMPLES
+  apimatic api validate
+
+  apimatic api validate --input=./
+
+  apimatic api validate --file=./specs/sample.json
+
+  apimatic api validate --url="https://petstore.swagger.io/v2/swagger.json"
+```
+
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/validate.ts)_
+
+## `apimatic auth login`
+
+Login to your APIMatic account
+
+```
+USAGE
+  $ apimatic auth login [-k <value>]
+
+FLAGS
+  -k, --auth-key=<value>  Sets authentication key for all commands.
+
+DESCRIPTION
+  Login to your APIMatic account
+
+  Login using your APIMatic credentials or an API Key
+
+EXAMPLES
+  apimatic auth login
+
+  apimatic auth login --auth-key={api-key}
+```
+
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/login.ts)_
+
+## `apimatic auth logout`
+
+Clears the local login credentials.
+
+```
+USAGE
+  $ apimatic auth logout
+
+DESCRIPTION
+  Clears the local login credentials.
+
+  Clears the local login credentials. This will also clear any cached credentials from the CLI.
+
+EXAMPLES
+  apimatic auth logout
+```
+
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/logout.ts)_
+
+## `apimatic auth status`
+
+View the currently logged in user.
+
+```
+USAGE
+  $ apimatic auth status
+
+DESCRIPTION
+  View the currently logged in user.
+
+EXAMPLES
+  apimatic auth status
+```
+
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/status.ts)_
+
+## `apimatic autocomplete [SHELL]`
+
+Display autocomplete installation instructions.
+
+```
+USAGE
+  $ apimatic autocomplete [SHELL] [-r]
+
+ARGUMENTS
+  [SHELL]  (zsh|bash|powershell) Shell type
+
+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 powershell
+
+  $ apimatic autocomplete --refresh-cache
+```
+
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.47/src/commands/autocomplete/index.ts)_
+
+## `apimatic help [COMMAND]`
+
+Display help for apimatic.
+
+```
+USAGE
+  $ apimatic help [COMMAND...] [-n]
+
+ARGUMENTS
+  [COMMAND...]  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for apimatic.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.46/src/commands/help.ts)_
+
+## `apimatic plugin generate`
+
+Generate a context plugin for your SDKs.
+
+```
+USAGE
+  $ apimatic plugin generate [-i <value>] [-d <value>] [-f] [-k <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: <input>/plugin] path where the plugin will be generated.
+  -f, --force                overwrite changes without asking for user consent.
+  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
+                             API specifications and configuration files.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
+
+DESCRIPTION
+  Generate a context plugin for your SDKs.
+
+  Generate a context plugin that teaches an AI coding assistant how to use your SDKs. Requires an input directory
+  containing a `src` directory with your API specification — `apimatic.json` is created if it is not there. It asks
+  for the plugin's name on the first run, and for its languages only when `apimatic.json` records none (`sdk publish`
+  records them). Later runs read both from `apimatic.json` without asking.
+
+EXAMPLES
+  apimatic plugin generate
+
+  apimatic plugin generate --input="./" --destination="./plugin"
+```
+
+_See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/generate.ts)_
+
+## `apimatic plugin publish`
+
+Print the git commands for publishing your context plugin to GitHub.
+
+```
+USAGE
+  $ apimatic plugin publish [-i <value>] [-d <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: <input>/plugin] path where the plugin was generated.
+  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
+                             API specifications and configuration files.
+
+DESCRIPTION
+  Print the git commands for publishing your context plugin to GitHub.
+
+  Print the commands that publish a generated context plugin to a GitHub repository. The commands are printed for you to
+  run — this command never touches your repository.
+
+EXAMPLES
+  apimatic plugin publish
+
+  apimatic plugin publish --input="./" --destination="./plugin"
+```
+
+_See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/publish.ts)_
+
+## `apimatic portal generate`
+
+Generate a static API Documentation Portal.
+
+```
+USAGE
+  $ apimatic portal generate [--zip] [-i <value>] [-d <value>] [-f] [-k <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: <input>/portal] path where the portal will be generated.
+  -f, --force                overwrite changes without asking for user consent.
+  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
+                             API specifications and configuration files.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
+      --zip                  write the generated portal as a .zip archive.
+
+DESCRIPTION
+  Generate a static API Documentation Portal.
+
+  Builds a documentation portal from the OpenAPI documents and Markdown pages in your 'src' directory.
+
+  Each OpenAPI document at the top of 'src/spec' gets a section of the API reference, and the SDKs are built from one of
+  them. To build the SDKs from several, put each in a folder of its own and set 'MergeConfiguration.MergeApis' to true
+  in an 'APIMATIC-META.json' beside the folders; each folder then gets a section.
+
+  The portal is built on your machine and written as static files for any static host, served at its root or, when
+  'portal.site.url' has a path such as 'https://example.com/docs', at that path. Configure it with 'src/apimatic.json',
+  whose 'languages' block gives the portal a page for each SDK language, and whose 'plugin' block, or a 'pluginUrl' in
+  its 'portal' block for a plugin hosted elsewhere, a page for the context plugin.
+
+EXAMPLES
+  apimatic portal generate
+
+  apimatic portal generate --input=./ --destination=./portal
+
+  apimatic portal generate --zip
+```
+
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/generate.ts)_
+
+## `apimatic portal serve`
+
+Preview your API Documentation Portal with live reload.
+
+```
+USAGE
+  $ apimatic portal serve [-p 23513] [-o] [-i <value>] [-k <value>]
+
+FLAGS
+  -i, --input=<value>     [default: ./] path to the parent directory containing the 'src' directory, which includes API
+                          specifications and configuration files.
+  -k, --auth-key=<value>  override current authentication state with an authentication key.
+  -o, --open              open the portal in the default browser.
+  -p, --port=23513        [default: 23513] port to serve the portal on.
+
+DESCRIPTION
+  Preview your API Documentation Portal with live reload.
+
+  Serves the portal described by 'src/apimatic.json' from your machine, reloading the browser as you edit the Markdown
+  pages in 'src/content', reorder them in a 'nav.json', edit the documents in 'src/spec', or change the 'portal',
+  'languages' or 'plugin' block of 'apimatic.json'.
+
+  Adding a language or a 'plugin' block, adding or removing a page in 'src/content', creating 'src/static', changing
+  which documents are in 'src/spec' or which folders its 'APIMATIC-META.json' merges, or changing the path in
+  'portal.site.url', needs the preview restarted.
+
+  Nothing is written to disk; run 'apimatic portal generate' to produce the static files.
+
+EXAMPLES
+  apimatic portal serve
+
+  apimatic portal serve --input=./ --port=23513 --open
+```
+
+_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/serve.ts)_
+
+## `apimatic publishing profile list`
+
+List all publishing profiles
+
+```
+USAGE
+  $ apimatic publishing profile list
+
+DESCRIPTION
+  List all publishing profiles
+
+  Display all publishing profiles associated with your account, including each profile's name, ID and enabled languages.
+
+EXAMPLES
+  apimatic publishing profile list
+```
+
+_See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/publishing/profile/list.ts)_
+
+## `apimatic quickstart`
+
+Create your API Documentation Portal, SDKs and Context Plugins.
+
+```
+USAGE
+  $ apimatic quickstart
+
+DESCRIPTION
+  Create your API Documentation Portal, SDKs and Context Plugins.
+
+  Point the CLI at your API specification and it builds a documentation portal, SDKs, and a context plugin that teaches
+  an AI coding assistant to use them.
+
+EXAMPLES
+  apimatic quickstart
+```
+
+_See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/quickstart.ts)_
+
+## `apimatic sdk generate`
+
+Generate an SDK for your API
+
+```
+USAGE
+  $ apimatic sdk generate -l csharp|java|php|python|ruby|typescript|go [-d <value>] [--api-version <value>]
+    [--zip] [--codegen-version v4] [--stability stable|beta] [-i <value>] [-f] [-k <value>]
+
+FLAGS
+  -d, --destination=<value>       [default: <input>/sdk/<language> | <input>/sdk/<api-version>/<language>] path where
+                                  the SDK will be generated
+  -f, --force                     overwrite changes without asking for user consent.
+  -i, --input=<value>             [default: ./] path to the parent directory containing the 'src' directory, which
+                                  includes API specifications and configuration files.
+  -k, --auth-key=<value>          override current authentication state with an authentication key.
+  -l, --language=<option>         (required) Programming language for SDK generation
+                                  <options: csharp|java|php|python|ruby|typescript|go>
+      --api-version=<value>       Version of the API to use for SDK generation (if multiple versions exist)
+      --codegen-version=<option>  [default: v4] Version of the code generator to use
+                                  <options: v4>
+      --stability=<option>        Stability level of the generated SDK. Defaults to the level the language offers.
+                                  <options: stable|beta>
+      --zip                       Download the generated SDK as a .zip archive
+
+DESCRIPTION
+  Generate an SDK for your API
+
+  Generate a Software Development Kit (SDK) from an API specification.
+  C#, TypeScript and Python are available; Java, Ruby, Go and PHP are coming soon.
+
+EXAMPLES
+  apimatic sdk generate --language=typescript
+
+  apimatic sdk generate --language=csharp --input=./
+
+  apimatic sdk generate --language=python --destination=./sdk --zip
+```
+
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/generate.ts)_
+
+## `apimatic sdk publish`
+
+Generate and publish an SDK to a package registry and/or source repository
+
+```
+USAGE
+  $ apimatic sdk publish [-p <value>] [-v <value>] [-d <value>] [-l csharp|java|php|python|ruby|typescript|go]
+    [-f] [-i <value>] [--publish-type package|sourcecode...] [--dry-run] [--codegen-version v4] [--stability
+    stable|beta]
+
+FLAGS
+  -d, --destination=<value>       [default: <input>/sdk] path where the sdk will be generated.
+  -f, --force                     overwrite changes without asking for user consent.
+  -i, --input=<value>             [default: ./] path to the parent directory containing the 'src' directory, which
+                                  includes API specifications and configuration files.
+  -l, --language=<option>         Language of the SDK to generate and publish.
+                                  <options: csharp|java|php|python|ruby|typescript|go>
+  -p, --profile-id=<value>        Id of the publishing profile to use.
+  -v, --version=<value>           Semantic version of the SDK to publish (e.g. 1.0.0).
+      --codegen-version=<option>  [default: v4] Version of the code generator to use
+                                  <options: v4>
+      --dry-run                   Generate the SDK locally for review without publishing.
+      --publish-type=<option>...  One or more publishing targets: 'package' for a package registry, 'sourcecode' for a
+                                  git repository.
+                                  <options: package|sourcecode>
+      --stability=<option>        Stability level of the generated SDK. Defaults to the level the language offers.
+                                  <options: stable|beta>
+
+DESCRIPTION
+  Generate and publish an SDK to a package registry and/or source repository
+
+  Generate and publish an SDK using a publishing profile configured in the APIMatic App. Requires an input directory
+  containing the API specification. Run without flags for a step-by-step interactive experience, or pass all required
+  flags for CI/CD automation.
+
+EXAMPLES
+  apimatic sdk publish
+
+  apimatic sdk publish --profile-id=a1b2c3d4e5f6a1b2c3d4e5f6 --language=typescript --version=1.0.0 --publish-type=package --publish-type=sourcecode
+
+  apimatic sdk publish --profile-id=b2c3d4e5f6a1b2c3d4e5f6a1 --language=csharp --version=2.0.0 --publish-type=sourcecode
+
+  apimatic sdk publish --profile-id=c3d4e5f6a1b2c3d4e5f6a1b2 --language=python --version=1.0.0 --publish-type=package --dry-run
+```
+
+_See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/publish.ts)_
+<!-- commandsstop -->

From 3aba51c73e04f42f4ab69acb58bae9efe84b1a7f Mon Sep 17 00:00:00 2001
From: saeedjamshaid <muhammad.saeed@apimatic.io>
Date: Mon, 26 Oct 2026 17:01:30 +0500
Subject: [PATCH 2/4] docs: point the README's code links at main and drop its
 1.3.1 version line

oclif.repositoryPrefix makes `pnpm readme` link each command's source on main;
its default, blob/v<version>, now gives v0.0.0-semantically-released. The usage
block is no longer generated, so it loses the stale version line, and the
License badge now links LICENSE on main instead of a 404 on master.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---
 .gitattributes |  1 +
 README.md      | 36 ++++++++++++++++--------------------
 package.json   |  1 +
 3 files changed, 18 insertions(+), 20 deletions(-)

diff --git a/.gitattributes b/.gitattributes
index 07142a065..343dddb2e 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1 +1,2 @@
+# oclif readme finds its blocks only in an LF file; in a CRLF one it adds a second copy of each.
 /README.md text eol=lf
diff --git a/README.md b/README.md
index ec3f95499..e4e3c66b1 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ The official CLI for APIMatic.
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
 [![Version](https://img.shields.io/npm/v/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
 [![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)
+[![License](https://img.shields.io/npm/l/@apimatic/cli.svg)](https://github.com/apimatic/apimatic-cli/blob/main/LICENSE)
 
 # Requirements
 
@@ -22,19 +22,15 @@ $ apimatic quickstart
 ```
 
 # Usage
-<!-- usage -->
 ```sh-session
 $ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
-$ apimatic (--version)
-@apimatic/cli/1.3.1 win32-x64 node-v24.19.0
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
 ...
 ```
-<!-- usagestop -->
 
 # Commands
 <!-- commands -->
@@ -86,7 +82,7 @@ EXAMPLES
   apimatic api transform --format=raml --url="https://petstore.swagger.io/v2/swagger.json" --destination=./
 ```
 
-_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/transform.ts)_
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/api/transform.ts)_
 
 ## `apimatic api validate`
 
@@ -119,7 +115,7 @@ EXAMPLES
   apimatic api validate --url="https://petstore.swagger.io/v2/swagger.json"
 ```
 
-_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/validate.ts)_
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/api/validate.ts)_
 
 ## `apimatic auth login`
 
@@ -143,7 +139,7 @@ EXAMPLES
   apimatic auth login --auth-key={api-key}
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/auth/login.ts)_
 
 ## `apimatic auth logout`
 
@@ -162,7 +158,7 @@ EXAMPLES
   apimatic auth logout
 ```
 
-_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/auth/logout.ts)_
 
 ## `apimatic auth status`
 
@@ -179,7 +175,7 @@ EXAMPLES
   apimatic auth status
 ```
 
-_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/auth/status.ts)_
 
 ## `apimatic autocomplete [SHELL]`
 
@@ -251,8 +247,8 @@ DESCRIPTION
   Generate a context plugin for your SDKs.
 
   Generate a context plugin that teaches an AI coding assistant how to use your SDKs. Requires an input directory
-  containing a `src` directory with your API specification — `apimatic.json` is created if it is not there. It asks
-  for the plugin's name on the first run, and for its languages only when `apimatic.json` records none (`sdk publish`
+  containing a `src` directory with your API specification — `apimatic.json` is created if it is not there. It asks for
+  the plugin's name on the first run, and for its languages only when `apimatic.json` records none (`sdk publish`
   records them). Later runs read both from `apimatic.json` without asking.
 
 EXAMPLES
@@ -261,7 +257,7 @@ EXAMPLES
   apimatic plugin generate --input="./" --destination="./plugin"
 ```
 
-_See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/generate.ts)_
+_See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/plugin/generate.ts)_
 
 ## `apimatic plugin publish`
 
@@ -288,7 +284,7 @@ EXAMPLES
   apimatic plugin publish --input="./" --destination="./plugin"
 ```
 
-_See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/publish.ts)_
+_See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/plugin/publish.ts)_
 
 ## `apimatic portal generate`
 
@@ -328,7 +324,7 @@ EXAMPLES
   apimatic portal generate --zip
 ```
 
-_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/generate.ts)_
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/portal/generate.ts)_
 
 ## `apimatic portal serve`
 
@@ -364,7 +360,7 @@ EXAMPLES
   apimatic portal serve --input=./ --port=23513 --open
 ```
 
-_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/serve.ts)_
+_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/portal/serve.ts)_
 
 ## `apimatic publishing profile list`
 
@@ -383,7 +379,7 @@ EXAMPLES
   apimatic publishing profile list
 ```
 
-_See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/publishing/profile/list.ts)_
+_See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/publishing/profile/list.ts)_
 
 ## `apimatic quickstart`
 
@@ -403,7 +399,7 @@ EXAMPLES
   apimatic quickstart
 ```
 
-_See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/quickstart.ts)_
+_See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/quickstart.ts)_
 
 ## `apimatic sdk generate`
 
@@ -444,7 +440,7 @@ EXAMPLES
   apimatic sdk generate --language=python --destination=./sdk --zip
 ```
 
-_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/generate.ts)_
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/sdk/generate.ts)_
 
 ## `apimatic sdk publish`
 
@@ -491,5 +487,5 @@ EXAMPLES
   apimatic sdk publish --profile-id=c3d4e5f6a1b2c3d4e5f6a1b2 --language=python --version=1.0.0 --publish-type=package --dry-run
 ```
 
-_See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/publish.ts)_
+_See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/sdk/publish.ts)_
 <!-- commandsstop -->
diff --git a/package.json b/package.json
index f6e56df41..4074fbbb3 100644
--- a/package.json
+++ b/package.json
@@ -155,6 +155,7 @@
         "commands": "./lib/commands",
         "dirname": "apimatic",
         "bin": "apimatic",
+        "repositoryPrefix": "<%- repo %>/blob/main/<%- commandPath %>",
         "description": "The official CLI for APIMatic. \nTo get started with APIMatic's CLI using a step by step wizard, run 'apimatic quickstart'.",
         "hooks": {
             "init": "./lib/hooks/node-version",

From 7007574ee84a72ff392dff3dd588aaa9bee4b3b6 Mon Sep 17 00:00:00 2001
From: saeedjamshaid <muhammad.saeed@apimatic.io>
Date: Tue, 27 Oct 2026 17:42:17 +0500
Subject: [PATCH 3/4] docs: link the README's command code at dev, and at the
 release tag once packed

The committed README links dev, where every command exists. prepack now
regenerates the README, so the one npm shows links the tag semantic-release
pushes before it publishes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---
 README.md    | 26 +++++++++++++-------------
 package.json |  4 ++--
 2 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index e4e3c66b1..511ab4d36 100644
--- a/README.md
+++ b/README.md
@@ -82,7 +82,7 @@ EXAMPLES
   apimatic api transform --format=raml --url="https://petstore.swagger.io/v2/swagger.json" --destination=./
 ```
 
-_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/api/transform.ts)_
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/api/transform.ts)_
 
 ## `apimatic api validate`
 
@@ -115,7 +115,7 @@ EXAMPLES
   apimatic api validate --url="https://petstore.swagger.io/v2/swagger.json"
 ```
 
-_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/api/validate.ts)_
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/api/validate.ts)_
 
 ## `apimatic auth login`
 
@@ -139,7 +139,7 @@ EXAMPLES
   apimatic auth login --auth-key={api-key}
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/auth/login.ts)_
 
 ## `apimatic auth logout`
 
@@ -158,7 +158,7 @@ EXAMPLES
   apimatic auth logout
 ```
 
-_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/auth/logout.ts)_
 
 ## `apimatic auth status`
 
@@ -175,7 +175,7 @@ EXAMPLES
   apimatic auth status
 ```
 
-_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/auth/status.ts)_
 
 ## `apimatic autocomplete [SHELL]`
 
@@ -257,7 +257,7 @@ EXAMPLES
   apimatic plugin generate --input="./" --destination="./plugin"
 ```
 
-_See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/plugin/generate.ts)_
+_See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/plugin/generate.ts)_
 
 ## `apimatic plugin publish`
 
@@ -284,7 +284,7 @@ EXAMPLES
   apimatic plugin publish --input="./" --destination="./plugin"
 ```
 
-_See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/plugin/publish.ts)_
+_See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/plugin/publish.ts)_
 
 ## `apimatic portal generate`
 
@@ -324,7 +324,7 @@ EXAMPLES
   apimatic portal generate --zip
 ```
 
-_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/portal/generate.ts)_
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/portal/generate.ts)_
 
 ## `apimatic portal serve`
 
@@ -360,7 +360,7 @@ EXAMPLES
   apimatic portal serve --input=./ --port=23513 --open
 ```
 
-_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/portal/serve.ts)_
+_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/portal/serve.ts)_
 
 ## `apimatic publishing profile list`
 
@@ -379,7 +379,7 @@ EXAMPLES
   apimatic publishing profile list
 ```
 
-_See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/publishing/profile/list.ts)_
+_See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/publishing/profile/list.ts)_
 
 ## `apimatic quickstart`
 
@@ -399,7 +399,7 @@ EXAMPLES
   apimatic quickstart
 ```
 
-_See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/quickstart.ts)_
+_See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/quickstart.ts)_
 
 ## `apimatic sdk generate`
 
@@ -440,7 +440,7 @@ EXAMPLES
   apimatic sdk generate --language=python --destination=./sdk --zip
 ```
 
-_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/sdk/generate.ts)_
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/sdk/generate.ts)_
 
 ## `apimatic sdk publish`
 
@@ -487,5 +487,5 @@ EXAMPLES
   apimatic sdk publish --profile-id=c3d4e5f6a1b2c3d4e5f6a1b2 --language=python --version=1.0.0 --publish-type=package --dry-run
 ```
 
-_See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/main/src/commands/sdk/publish.ts)_
+_See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/dev/src/commands/sdk/publish.ts)_
 <!-- commandsstop -->
diff --git a/package.json b/package.json
index 4074fbbb3..b8a353412 100644
--- a/package.json
+++ b/package.json
@@ -43,7 +43,7 @@
         "build": "rimraf lib tsconfig.tsbuildinfo oclif.manifest.json && tsc",
         "build:watch": "rimraf oclif.manifest.json && tsc --watch",
         "apimatic": "node ./bin/run.js",
-        "prepack": "oclif manifest",
+        "prepack": "oclif manifest && oclif readme",
         "pretest": "tsc -p test/tsconfig.json",
         "posttest": "eslint .",
         "prettier": "prettier \"src/**/*.{js,ts}\" \"portal-template/**/*.{ts,tsx}\"",
@@ -155,7 +155,7 @@
         "commands": "./lib/commands",
         "dirname": "apimatic",
         "bin": "apimatic",
-        "repositoryPrefix": "<%- repo %>/blob/main/<%- commandPath %>",
+        "repositoryPrefix": "<%- repo %>/blob/<%- version === '0.0.0-semantically-released' ? 'dev' : 'v' + version %>/<%- commandPath %>",
         "description": "The official CLI for APIMatic. \nTo get started with APIMatic's CLI using a step by step wizard, run 'apimatic quickstart'.",
         "hooks": {
             "init": "./lib/hooks/node-version",

From 458c7d325b3c9ce17f0d14446fcae88fff075dfb Mon Sep 17 00:00:00 2001
From: saeedjamshaid <muhammad.saeed@apimatic.io>
Date: Tue, 27 Oct 2026 17:42:23 +0500
Subject: [PATCH 4/4] docs: note how to regenerate the README

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---
 .ai/instructions.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/.ai/instructions.md b/.ai/instructions.md
index 499e9b545..71fcd03bd 100644
--- a/.ai/instructions.md
+++ b/.ai/instructions.md
@@ -19,6 +19,9 @@ pnpm lint:fix          # ESLint with --fix --quiet
 # Format
 pnpm format            # Prettier write on src/**/*.{js,ts}
 
+# README
+pnpm readme            # after pnpm build; needs colour on (FORCE_COLOR=1 without a TTY, NO_COLOR unset) and COLUMNS unset
+
 # Test (all)
 pnpm test              # tsx + mocha, runs test/**/*.test.ts