Skip to main content

CLI Usage

$ npm install -g @the-codegen-project/cli
$ codegen COMMAND
running command...
$ codegen (--version)
@the-codegen-project/cli/0.24.1 linux-x64 node-v18.20.4
$ codegen --help [COMMAND]
USAGE
  $ codegen COMMAND
...

Table of contents​

Commands​

codegen autocomplete [SHELL]​

Display autocomplete installation instructions.

USAGE
  $ codegen 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
  $ codegen autocomplete

  $ codegen autocomplete bash

  $ codegen autocomplete zsh

  $ codegen autocomplete powershell

  $ codegen autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

codegen generate [FILE]​

Generate code based on your configuration, use init to get started.

USAGE
  $ codegen generate [FILE] [--help]

ARGUMENTS
  FILE  Path or URL to the configuration file, defaults to root of where the command is run

FLAGS
  --help  Show CLI help.

DESCRIPTION
  Generate code based on your configuration, use `init` to get started.

See code: src/commands/generate.ts

codegen help [COMMAND]​

Display help for codegen.

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

See code: @oclif/plugin-help

codegen init​

Initialize The Codegen Project in your project

USAGE
  $ codegen init [--help] [--input-file <value>] [--config-name <value>] [--input-type asyncapi]
    [--output-directory <value>] [--config-type esm|json|yaml|ts] [--languages typescript] [--no-tty]
    [--include-payloads] [--include-headers] [--include-client] [--include-parameters] [--include-channels]

FLAGS
  --config-name=<value>       [default: codegen] The name to use for the configuration file (dont include file
                              extension)
  --config-type=<option>      [default: esm] The type of configuration file. 'esm', 'ts' can do everything, 'json' and
                              'yaml' is more restrictive. Read more here:
                              https://github.com/the-codegen-project/cli/blob/main/docs/configurations.md
                              <options: esm|json|yaml|ts>
  --help                      Show CLI help.
  --include-channels          Include channels generation, available for TypeScript
  --include-client            Include client generation, available for TypeScript
  --include-headers           Include headers generation, available for TypeScript
  --include-parameters        Include parameters generation, available for TypeScript
  --include-payloads          Include payloads generation, available for TypeScript
  --input-file=<value>        File path for the code generation input such as AsyncAPI document
  --input-type=<option>       Input file type
                              <options: asyncapi>
  --languages=<option>        Which languages do you wish to generate code for?
                              <options: typescript>
  --no-tty                    Do not use an interactive terminal
  --output-directory=<value>  [default: ./] Output configuration location, path to where the configuration file should
                              be located. If relative path, the current working directory of the terminal will be used

DESCRIPTION
  Initialize The Codegen Project in your project

See code: src/commands/init.ts

codegen version​

USAGE
  $ codegen version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version