konfig-cli

konfig-cli

CLI for dash.konfigthis.com

• konfig-cli
• Usage
• Commands

Usage

$ npm install -g konfig-cli
$ konfig COMMAND
running command...
$ konfig (--version)
konfig-cli/1.39.3 linux-x64 node-v16.20.2
$ konfig --help [COMMAND]
USAGE
  $ konfig COMMAND
...

Commands

• konfig bump
• konfig changeset
• konfig detect-breaking-change
• konfig diff
• konfig fix
• konfig generate
• konfig help [COMMAND]
• konfig ignore
• konfig init
• konfig lint
• konfig lint-python
• konfig list-sdk-submodules
• konfig login
• konfig logout
• konfig mock
• konfig openapi-schema-validate
• konfig p2o
• konfig pr-create
• konfig pr-merge
• konfig publish
• konfig published
• konfig pull
• konfig push
• konfig revalidate-demos [FILE]
• konfig revalidate-portal [FILE]
• konfig slack-msg [FILE]
• konfig test
• konfig version

konfig bump

Automatically bump semantic version of SDKs. If a breaking change is detected then the major version will be bumped. Otherwise a minor version will be bumped.

USAGE
  $ konfig bump [-g <value>] [-p | -m | -M | -r]

FLAGS
  -M, --major
  -g, --generator=<value>
  -m, --minor
  -p, --patch
  -r, --prerelease

DESCRIPTION
  Automatically bump semantic version of SDKs. If a breaking change is detected then the major version will be bumped.
  Otherwise a minor version will be bumped.

EXAMPLES
  $ konfig bump

See code: dist/commands/bump.ts

konfig changeset

Generate konfig changeset file

USAGE
  $ konfig changeset [-a] [-m <value>] [-g <value>]

FLAGS
  -a, --all                Include all SDKs in changeset
  -g, --generator=<value>  Comma-separated list of generators to add to changeset
  -m, --message=<value>    Changeset message

DESCRIPTION
  Generate konfig changeset file

EXAMPLES
  $ konfig changeset

  $ konfig changeset -a

  $ konfig changeset -a -m "My changeset message"

  $ konfig changeset -g python

See code: dist/commands/changeset.ts

konfig detect-breaking-change

Automatically finds base branch and detects if there is a breaking change.

USAGE
  $ konfig detect-breaking-change -m <value> -s <value>

FLAGS
  -m, --mainBranch=<value>  (required)
  -s, --specPath=<value>    (required)

DESCRIPTION
  Automatically finds base branch and detects if there is a breaking change.

EXAMPLES
  $ konfig detect-breaking-change

See code: dist/commands/detect-breaking-change.ts

konfig diff

Generate diff between OAS specs (https://github.com/opticdev/optic)

USAGE
  $ konfig diff

DESCRIPTION
  Generate diff between OAS specs (https://github.com/opticdev/optic)

EXAMPLES
  $ konfig diff

See code: dist/commands/diff.ts

konfig fix

Tool for automatically fixing an OpenAPI Specification.

USAGE
  $ konfig fix [-f] [-i <value>] [-s <value>] [-a] [-k <value>] [--skipMissingResponseDescriptionFix]
    [--skipListUsageSecurity] [-Y] [--ci] [-A] [-T] [-p <value>] [-n]

FLAGS
  -A, --useAIForOperationId                 Use openAI API to generate operationIds based on rules defined here:
                                            https://konfigthis.com/docs/tutorials/naming-operation-ids. Requires
                                            OPENAI_API_KEY to be set in environment.
  -T, --useAIForTags                        Use openAI API to assign tags to operations which do not have tags, and to
                                            generate tags for the OAS if they are missing. Requires OPENAI_API_KEY to be
                                            set in environment.
  -Y, --[no-]alwaysYes                      Always confirm with "Yes"("Y") when asked
  -a, --[no-]auto                           Automatically generate names if asked
  -f, --format                              Formats input specification
  -i, --specInputPath=<value>               Path to input OpenAPI Specification
  -k, --konfigDir=<value>                   Directory containing konfig.yaml
  -n, --noInput                             Run in a mode which requires no input whatsoever from the user. This flag
                                            will enable --alwaysYes, --auto, --ci, --useAIForOperationId, and
                                            --useAIForTags flags; any other rules which attempt to prompt for input will
                                            be ignored.
  -p, --progressYamlOverridePath=<value>    Override path to read and write progress.yaml file.
  -s, --spec=<value>                        Path to output OpenAPI Specification
  --ci                                      Run in CI mode: answers default for all prompts if applicable
  --[no-]skipListUsageSecurity              Ignores fixing list usage of security
  --[no-]skipMissingResponseDescriptionFix  Ignores fixing a missing description in response schema

DESCRIPTION
  Tool for automatically fixing an OpenAPI Specification.

EXAMPLES
  $ konfig fix

See code: dist/commands/fix.ts

konfig generate

Generate SDKs. Expects a konfig.yaml file in the current directory.

USAGE
  $ konfig generate [-x] [-w <value>] [-i <value>] [-c <value>] [-s <value> | -o <value>] [-n] [-j <value>]
    [-p <value>] [-t <value>] [-C <value>] [-S <value>] [-P <value>] [-k <value>] [-g <value>] [-O <value>] [-f <value>]

FLAGS
  -C, --copyCSharpOutputDir=<value>      Path to C# output directory. Contents of existing directory will be deleted
                                         first.
  -O, --copyObjcOutputDir=<value>        Path to Objective-C output directory. Contents of existing directory will be
                                         deleted first.
  -P, --copyPHPOutputDir=<value>         Path to PHP output directory. Contents of existing directory will be deleted
                                         first.
  -S, --copySwiftOutputDir=<value>       Path to Swift output directory. Contents of existing directory will be deleted
                                         first.
  -c, --configDir=<value>                Path to configuration directory.
  -f, --generatorFilter=<value>          Comma separated list of generators to run (e.g. "-f
                                         python,java,go,csharp,objc")
  -g, --copyGoOutputDir=<value>          Path to Go output directory. Contents of existing directory will be deleted
                                         first.
  -i, --inputSpec=<value>                Path to OpenAPI Spec file.
  -j, --copyJavaOutputDir=<value>        Path to java output directory. Contents of existing directory will be deleted
                                         first.
  -k, --copyKotlinOutputDir=<value>      Path to Kotlin output directory. Contents of existing directory will be deleted
                                         first.
  -n, --doNotCopy                        Do not copy
  -o, --outputDir=<value>                Path to output directory. Deletes any existing directory at output location.
  -p, --copyPythonOutputDir=<value>      Path to python output directory. Contents of existing directory will be deleted
                                         first.
  -s, --outputSpec=<value>               Return the transformed specs to a specified directory.
  -t, --copyTypescriptOutputDir=<value>  Path to typescript output directory. Contents of existing directory will be
                                         deleted first.
  -w, --watch=<value>                    Watch any files under a regex pattern and re-run generation if any files are
                                         changed. Be default "konfig.yaml" is always added to the watch list. This is
                                         generally only useful for when you are actively customizing / testing an SDK.
  -x, --onlyCopyAdditionalGenerators     Only copy generated SDKs specified under 'additionalGenerators'

DESCRIPTION
  Generate SDKs. Expects a konfig.yaml file in the current directory.

EXAMPLES
  $ konfig generate

See code: dist/commands/generate.ts

konfig help [COMMAND]

Display help for konfig.

USAGE
  $ konfig 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 konfig.

See code: @oclif/plugin-help

konfig ignore

Helper command for adding to .konfigignore

USAGE
  $ konfig ignore -g <value>

FLAGS
  -g, --glob=<value>  (required) Glob of paths to add to .konfigignore

DESCRIPTION
  Helper command for adding to .konfigignore

EXAMPLES
  $ konfig ignore

See code: dist/commands/ignore.ts

konfig init

Initialize a Konfig repository

USAGE
  $ konfig init [-s] [-a] [-f] [-t <value>]

FLAGS
  -a, --githubAction
  -f, --overwrite
  -s, --settings
  -t, --target=<value>

DESCRIPTION
  Initialize a Konfig repository

EXAMPLES
  $ konfig init

See code: dist/commands/init.ts

konfig lint

Lint your OpenAPI Spec

USAGE
  $ konfig lint

DESCRIPTION
  Lint your OpenAPI Spec

EXAMPLES
  $ konfig lint

See code: dist/commands/lint.ts

konfig lint-python

Lint your python SDK with ruff linter

USAGE
  $ konfig lint-python [-f] [-p <value>]

FLAGS
  -f, --fix           fix linting errors which ruff marks as fixable
  -p, --path=<value>  lint only specified path (file or directory) within python sdk directory. Glob patterns are
                      allowed.

DESCRIPTION
  Lint your python SDK with ruff linter

EXAMPLES
  $ konfig lint-python

  $ konfig lint-python -p test/

  $ konfig lint-python -f -p test/**/*test*.py

  $ konfig lint-python -f -p test/simple_test.py

See code: dist/commands/lint-python.ts

konfig list-sdk-submodules

List paths of all sdks which are git submodules, each on a new line.

USAGE
  $ konfig list-sdk-submodules

DESCRIPTION
  List paths of all sdks which are git submodules, each on a new line.

EXAMPLES
  $ konfig list-sdk-submodules

See code: dist/commands/list-sdk-submodules.ts

konfig login

Login to api.konfigthis.com

USAGE
  $ konfig login

DESCRIPTION
  Login to api.konfigthis.com

EXAMPLES
  $ konfig login

See code: dist/commands/login.ts

konfig logout

Logout of Konfig

USAGE
  $ konfig logout

DESCRIPTION
  Logout of Konfig

EXAMPLES
  $ konfig logout

See code: dist/commands/logout.ts

konfig mock

Start a mock server from your OpenAPI Spec

USAGE
  $ konfig mock

DESCRIPTION
  Start a mock server from your OpenAPI Spec

EXAMPLES
  $ konfig mock

See code: dist/commands/mock.ts

konfig openapi-schema-validate

Utility for validating input data against an OpenAPI schema

USAGE
  $ konfig openapi-schema-validate -i <value> -s <value> -n <value>

FLAGS
  -i, --inputPath=<value>          (required) relative path from current working directory to file containing data to
                                   validate
  -n, --schemaName=<value>         (required) Name of the schema to validate against
  -s, --specificationPath=<value>  (required) relative path from current working directory to the OpenAPI specification

DESCRIPTION
  Utility for validating input data against an OpenAPI schema

EXAMPLES
  $ konfig openapi-schema-validate

See code: dist/commands/openapi-schema-validate.ts

konfig p2o

Convert Postman Collection to OpenAPI Spec

USAGE
  $ konfig p2o -p <value> -o <value>

FLAGS
  -o, --o=<value>  (required) Path to output OpenAPI Specification
  -p, --p=<value>  (required) Path to Postman Collection

DESCRIPTION
  Convert Postman Collection to OpenAPI Spec

EXAMPLES
  $ konfig p2o

See code: dist/commands/p2o.ts

konfig pr-create

Creates a github pull request

USAGE
  $ konfig pr-create -o <value> -r <value> -h <value> [-b <value>] [--title <value>] [--body <value>]

FLAGS
  -b, --base=<value>   Name of the branch you want to merge into
  -h, --head=<value>   (required) Name of the branch you want to merge from
  -o, --owner=<value>  (required) Owner of github repository
  -r, --repo=<value>   (required) Name of github repository
  --body=<value>       Body of the PR
  --title=<value>      Title of the PR

DESCRIPTION
  Creates a github pull request

EXAMPLES
  $ konfig pr-create

See code: dist/commands/pr-create.ts

konfig pr-merge

Merges a github pull request

USAGE
  $ konfig pr-merge -o <value> -r <value> -h <value> [-b <value>]

FLAGS
  -b, --base=<value>   Name of the branch you want to merge into
  -h, --head=<value>   (required) Name of the branch you want to merge from
  -o, --owner=<value>  (required) Owner of github repository
  -r, --repo=<value>   (required) Name of github repository

DESCRIPTION
  Merges a github pull request

EXAMPLES
  $ konfig pr-merge

See code: dist/commands/pr-merge.ts

konfig publish

Publish SDKs

USAGE
  $ konfig publish [-d] [-g <value> | -a] [-T] [-t] [--skipGitCleanCheck] [--skipRemoteCheck] [--skipTests]
    [-s] [-x] [--tolerateRepublish] [--ci]

FLAGS
  -T, --useTwine           Force use TWINE_USERNAME and TWINE_PASSWORD for publishing
  -a, --all                Specify all generators
  -d, --debug
  -g, --generator=<value>
  -s, --skipTag            Skip pushing git tag
  -t, --test
  -x, --noMockServer       Disable mock server from running
  --ci                     Run in CI mode. This ensures non-interactivity in all publishing actions.
  --skipGitCleanCheck      Do not check that git directory is clean
  --skipRemoteCheck        Do not check that remote is in sync
  --skipTests              Do not run tests before publishing
  --tolerateRepublish      Do not fail if package version already exists in package manager. Note that published version
                           will not be overridden. Used in CI

DESCRIPTION
  Publish SDKs

EXAMPLES
  $ konfig publish

See code: dist/commands/publish.ts

konfig published

Queries public package managers for published packages

USAGE
  $ konfig published [-l <value>]

FLAGS
  -l, --limit=<value>  [default: 5]

DESCRIPTION
  Queries public package managers for published packages

EXAMPLES
  $ konfig published

See code: dist/commands/published.ts

konfig pull

describe the command here

USAGE
  $ konfig pull [-i <value>] [-o <value>]

FLAGS
  -i, --input=<value>   input URL to poll
  -o, --output=<value>  Path to output spec file

DESCRIPTION
  describe the command here

EXAMPLES
  $ konfig pull

See code: dist/commands/pull.ts

konfig push

Pushes an OpenAPI Spec to an SDK repository

USAGE
  $ konfig push -o <value> -r <value> -s <value> [-x <value>]

FLAGS
  -o, --owner=<value>      (required) GitHub Owner of SDK Repository
  -r, --repo=<value>       (required) Name of GitHub SDK Repository
  -s, --spec=<value>       (required) Path to OpenAPI Specification file
  -x, --directory=<value>  Path from root of Git repository to directory containing konfig.yaml. This is useful if your
                           have multiple SDK repositories (directories containing a konfig.yaml file).

DESCRIPTION
  Pushes an OpenAPI Spec to an SDK repository

EXAMPLES
  $ konfig push

See code: dist/commands/push.ts

konfig revalidate-demos [FILE]

Revalidates demos for a particular organization and portal ID. This is required to ensure that the demo portal renders the latest demos from the demo repository.

USAGE
  $ konfig revalidate-demos [FILE] -o <value> -p <value>

FLAGS
  -o, --organizationId=<value>  (required) Organization ID
  -p, --portalId=<value>        (required) Portal ID

DESCRIPTION
  Revalidates demos for a particular organization and portal ID. This is required to ensure that the demo portal renders
  the latest demos from the demo repository.

EXAMPLES
  $ konfig revalidate-demos

See code: dist/commands/revalidate-demos.ts

konfig revalidate-portal [FILE]

Revalidates portal for a particular GitHub organization and repository. This is required to ensure that the portal renders the latest information from GitHub.

USAGE
  $ konfig revalidate-portal [FILE] -o <value> -r <value>

FLAGS
  -o, --owner=<value>       (required) Owner (e.g. "konfigthis" in "github.com/konfig-dev/konfig")
  -r, --repository=<value>  (required) Repository (e.g. "konfig" in "github.com/konfig-dev/konfig"))

DESCRIPTION
  Revalidates portal for a particular GitHub organization and repository. This is required to ensure that the portal
  renders the latest information from GitHub.

EXAMPLES
  $ konfig revalidate-portal

See code: dist/commands/revalidate-portal.ts

konfig slack-msg [FILE]

Generates a slack message

USAGE
  $ konfig slack-msg [FILE] [-g <value> | -a]

FLAGS
  -a, --all                Specify all generators
  -g, --generator=<value>

DESCRIPTION
  Generates a slack message

EXAMPLES
  $ konfig slack-msg

See code: dist/commands/slack-msg.ts

konfig test

Execute test script in every SDK directory

USAGE
  $ konfig test [-f <value>] [-s] [-x] [-p <value>] [-d]

FLAGS
  -d, --useDynamicResponseConfiguration  Use dynamic response configuration when mocking API for testing
  -f, --filter=<value>                   Comma separated list of SDKs to test (e.g. "-f python,java,go,csharp,objc")
  -p, --mockServerPort=<value>           [default: 4010] Port to run mock server on
  -s, --sequence                         Run tests in sequence
  -x, --noMockServer                     Disable mock server from running

DESCRIPTION
  Execute test script in every SDK directory

EXAMPLES
  $ konfig test

See code: dist/commands/test.ts

konfig version

Bumps version of each generator based on changesets.

USAGE
  $ konfig version

DESCRIPTION
  Bumps version of each generator based on changesets.

EXAMPLES
  $ konfig version

See code: dist/commands/version.ts