Skip to content

usage.md

Latest commit

 

History

History
235 lines (177 loc) · 7.61 KB

usage.md

File metadata and controls

235 lines (177 loc) · 7.61 KB
sidebar_position 3

CLI Usage

$ npm install -g @the-codegen-project/cli
$ codegen COMMAND
running command...
$ codegen (--version)
@the-codegen-project/cli/0.68.0 linux-x64 node-v22.22.0
$ 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 base

USAGE
  $ codegen base [--json] [--no-color] [--debug | [-q | -v | --silent] | ]

FLAGS
  -q, --quiet     Only show errors and warnings
  -v, --verbose   Show detailed output
      --debug     Show debug information
      --json      Output results as JSON for scripting
      --no-color  Disable colored output
      --silent    Suppress all output except fatal errors

See code: src/commands/base.ts

codegen generate [FILE]

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

USAGE
  $ codegen generate [FILE] [--json] [--no-color] [--debug | [-q | -v | --silent] | ] [--help] [-w] [-p
    <value>]

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

FLAGS
  -p, --watchPath=<value>  Optional path to watch for changes when --watch flag is used. If not provided, watches the
                           input file from configuration
  -q, --quiet              Only show errors and warnings
  -v, --verbose            Show detailed output
  -w, --watch              Watch for file changes and regenerate code automatically
      --debug              Show debug information
      --help               Show CLI help.
      --json               Output results as JSON for scripting
      --no-color           Disable colored output
      --silent             Suppress all output except fatal errors

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

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 [--json] [--no-color] [--debug |  | [--silent | -v | -q]] [--help] [--input-file <value>]
    [--config-name <value>] [--input-type asyncapi|openapi] [--output-directory <value>] [--config-type
    esm|json|yaml|ts] [--languages typescript] [--no-tty] [--include-payloads] [--include-headers] [--include-client]
    [--include-parameters] [--include-channels] [--gitignore-generated]

FLAGS
  -q, --quiet                     Only show errors and warnings
  -v, --verbose                   Show detailed output
      --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>
      --debug                     Show debug information
      --gitignore-generated       Add generated output directories to .gitignore
      --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|openapi>
      --json                      Output results as JSON for scripting
      --languages=<option>        Which languages do you wish to generate code for?
                                  <options: typescript>
      --no-color                  Disable colored output
      --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
      --silent                    Suppress all output except fatal errors

DESCRIPTION
  Initialize The Codegen Project in your project

See code: src/commands/init.ts

codegen telemetry ACTION

Manage telemetry settings

USAGE
  $ codegen telemetry ACTION [--json] [--no-color] [--debug | [-q | -v | --silent] | ] [--help]

ARGUMENTS
  ACTION  (status|enable|disable) Action to perform: status, enable, or disable

FLAGS
  -q, --quiet     Only show errors and warnings
  -v, --verbose   Show detailed output
      --debug     Show debug information
      --help      Show CLI help.
      --json      Output results as JSON for scripting
      --no-color  Disable colored output
      --silent    Suppress all output except fatal errors

DESCRIPTION
  Manage telemetry settings

EXAMPLES
  $ codegen telemetry status

  $ codegen telemetry enable

  $ codegen telemetry disable

See code: src/commands/telemetry.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