diff --git a/docs/README.md b/docs/README.md index 09364d7..ef5d2ea 100644 --- a/docs/README.md +++ b/docs/README.md @@ -68,3 +68,4 @@ Get an overview of how telemetry works for this project Connect AI assistants like Claude Code, Cursor, and Windsurf to The Codegen Project via MCP (Model Context Protocol) for intelligent code generation assistance. + diff --git a/docs/contributing.md b/docs/contributing.md index a1f2aeb..f4273ac 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -184,5 +184,6 @@ Prefix that follows specification is not enough though. Remember that the title + diff --git a/docs/migrations/v0.md b/docs/migrations/v0.md index 3e3c756..7d5c395 100644 --- a/docs/migrations/v0.md +++ b/docs/migrations/v0.md @@ -140,5 +140,6 @@ outputPath/ + diff --git a/docs/usage.md b/docs/usage.md index 9c308bf..cee6a12 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -9,7 +9,7 @@ $ npm install -g @the-codegen-project/cli $ codegen COMMAND running command... $ codegen (--version) -@the-codegen-project/cli/0.63.1 linux-x64 node-v18.20.8 +@the-codegen-project/cli/0.64.0 linux-x64 node-v18.20.8 $ codegen --help [COMMAND] USAGE $ codegen COMMAND @@ -27,6 +27,7 @@ USAGE * [`codegen autocomplete [SHELL]`](#codegen-autocomplete-shell) +* [`codegen base`](#codegen-base) * [`codegen generate [FILE]`](#codegen-generate-file) * [`codegen help [COMMAND]`](#codegen-help-command) * [`codegen init`](#codegen-init) @@ -64,13 +65,31 @@ EXAMPLES _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.18/src/commands/autocomplete/index.ts)_ +## `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](https://github.com/the-codegen-project/cli/blob/v0.64.0/src/commands/base.ts)_ + ## `codegen generate [FILE]` -Generate code based on your configuration, use `init` to get started. +Generate code based on your configuration, use `init` to get started, `generate` to generate code from the configuration. ``` USAGE - $ codegen generate [FILE] [--help] [-w] [-p ] + $ codegen generate [FILE] [--json] [--no-color] [--debug | [-q | -v | --silent] | ] [--help] [-w] [-p + ] ARGUMENTS FILE Path or URL to the configuration file, defaults to root of where the command is run @@ -78,14 +97,21 @@ ARGUMENTS FLAGS -p, --watchPath= 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 code based on your configuration, use `init` to get started, `generate` to generate code from the + configuration. ``` -_See code: [src/commands/generate.ts](https://github.com/the-codegen-project/cli/blob/v0.63.1/src/commands/generate.ts)_ +_See code: [src/commands/generate.ts](https://github.com/the-codegen-project/cli/blob/v0.64.0/src/commands/generate.ts)_ ## `codegen help [COMMAND]` @@ -113,39 +139,46 @@ Initialize The Codegen Project in your project ``` USAGE - $ codegen init [--help] [--input-file ] [--config-name ] [--input-type asyncapi|openapi] - [--output-directory ] [--config-type esm|json|yaml|ts] [--languages typescript] [--no-tty] - [--include-payloads] [--include-headers] [--include-client] [--include-parameters] [--include-channels] - [--gitignore-generated] + $ codegen init [--json] [--no-color] [--debug | | [--silent | -v | -q]] [--help] [--input-file ] + [--config-name ] [--input-type asyncapi|openapi] [--output-directory ] [--config-type + esm|json|yaml|ts] [--languages typescript] [--no-tty] [--include-payloads] [--include-headers] [--include-client] + [--include-parameters] [--include-channels] [--gitignore-generated] FLAGS - --config-name= [default: codegen] The name to use for the configuration file (dont include file - extension) - --config-type=