generated from SAP/repository-template
-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More CLI help texts, link to cds.compile (#1550)
- Add more CLI texts - Link from and to the CLI page --------- Co-authored-by: Steffen Waldmann <[email protected]>
- Loading branch information
Showing
8 changed files
with
300 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| <!-- this file is automatically generated and updated by a github action --> | ||
| <pre class="log"> | ||
| > cds compile --help | ||
|
|
||
| <strong>SYNOPSIS</strong> | ||
| <em>cds compile</em> <models> [<options>] | ||
|
|
||
| Compiles the specified models to CSN format, applying processors to unfold | ||
| and generate target outputs using the <options>. | ||
|
|
||
|
|
||
| <strong>OPTIONS</strong> | ||
|
|
||
| <em>-2</em> | <em>--to</em> <target format> | ||
|
|
||
| Compiles the given models to the specified <target format>. | ||
| Currently supported: | ||
|
|
||
| - json, yml | ||
| - edm, edmx, edmx-v2, edmx-v4, edmx-w4, edmx-x4 | ||
| - sql, hdbcds, hdbtable, hana | ||
| - cdl | ||
| - xsuaa | ||
| - openapi | ||
| - asyncapi | ||
|
|
||
| <em>-4</em> | <em>--for</em> <target> | ||
|
|
||
| Unfolds the compiled CSN for the specified <target> usages, | ||
| or get a comma-separated list, without generating target formats. | ||
| Currently supported: | ||
|
|
||
| - odata | ||
| - sql | ||
|
|
||
| <em>--dialect</em> <dialect> | ||
|
|
||
| Needs option <em>--to</em>. | ||
| Specify the dialect in combination with <em>--to sql</em>. | ||
| Currently supported: | ||
|
|
||
| - sqlite | ||
| - h2 | ||
| - postgres | ||
| - hana | ||
|
|
||
| <em>-s</em> | <em>--service</em> <name> | all | ||
|
|
||
| Chooses a specific service or <i>all</i> to force output for all services. | ||
| The service name must be fully qualified, including the namespace, if any. | ||
|
|
||
| <em>-l</em> | <em>--lang</em> <languages> | all | ||
|
|
||
| Localizes the output with given <languages>, a comma-separated list | ||
| of language/locale codes or <i>all</i>. | ||
| Localization is carried out before all other processors (-4/u) or backends (-2). | ||
|
|
||
| <em>-o</em> | <em>--dest</em> <folder> | ||
|
|
||
| Writes output to the given folder instead of stdout. | ||
|
|
||
| <em>-f</em> | <em>--flavor</em> sources | files | parsed | xtended | inferred | ||
|
|
||
| Depending on the argument, returns a model with the given level of detail: | ||
|
|
||
| sources: paths and content of all resolved source files | ||
| files: paths of all effectively referenced files | ||
| parsed: the definitions and extensions, without applying the | ||
| extensions or includes, and without imported definitions. | ||
| xtended: the definitions with all imports and extensions resolved, | ||
| but without any derived information | ||
| inferred: the effective model, including imported definitions, extensions, | ||
| and derived information. This is the default flavor. | ||
|
|
||
| <em>--parse</em> | ||
|
|
||
| Shortcut for '--flavor parsed' | ||
|
|
||
| <em>--plain</em> | ||
|
|
||
| Shortcut for '--flavor xtended' | ||
|
|
||
| <em>--docs</em> | ||
|
|
||
| Preserves /**...*/ doc comments in 'doc' properties of CSN outputs, | ||
| as well as in 'Core.Description' annotations of EDMX outputs. | ||
|
|
||
| <em>--locations</em> | ||
|
|
||
| Preserves $location properties of CSN outputs. | ||
|
|
||
| <em>--log-level</em> debug | info | warn | error | ||
|
|
||
| Chooses which level of compiler messages to log. The default log-level is <em>warn</em>. | ||
|
|
||
| <em>--openapi:url</em> <Server URL for Open API export> | ||
|
|
||
| The server URL used in the generated OpenAPI document. The default is the service | ||
| base path as declared in the CDS source. | ||
| Use the ${service-path} variable to have the service path included in the URL. | ||
|
|
||
| <em>--openapi:servers</em> <Stringified JSON Object for Open API export> | ||
|
|
||
| The servers definition used in the generated OpenAPI document. <em>--openapi:url</em> is | ||
| ignored when this option is specified. | ||
|
|
||
| <em>--odata-version</em> 4.0|4.01 | ||
|
|
||
| Adds the OData version's functionality of the input CDS/CSN file to the generated OpenAPI document. | ||
|
|
||
| <em>--openapi:diagram</em> | ||
|
|
||
| Include YUML diagram in the generated OpenAPI document, default: <em>false</em>. | ||
|
|
||
| <em>--openapi:config-file</em> filename | ||
|
|
||
| The passed configuration file will be read to generate the OpenAPI document, incorporating all specified options. | ||
| Precedence of Options: Inline options specified in the command line will take precedence over those defined in the configuration file. | ||
|
|
||
| <em>--asyncapi:merged</em> | ||
|
|
||
| A single AsyncAPI document is generated using the details of all input services. Information of <i>title</i> | ||
| and <i>version</i> should be provided as preset. | ||
|
|
||
| <strong>EXAMPLES</strong> | ||
| <em>cds</em> compile model.cds | ||
| <em>cds</em> c model.json --to sql | ||
| <em>cds</em> srv -s all -l all -2 edmx -o [4mout | ||
| <em>cds</em> compile srv -s sap.sample.TestService -2 asyncapi -o [0mout | ||
| </pre> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <!-- this file is automatically generated and updated by a github action --> | ||
| <pre class="log"> | ||
| > cds env --help | ||
|
|
||
| <strong>SYNOPSIS</strong> | ||
| <em>cds env</em> [<key>] [<options>] | ||
|
|
||
| <strong>EXPLANATION</strong> | ||
| Displays the effective configuration for the given key, or all of the | ||
| current environment. | ||
|
|
||
| <strong>OPTIONS</strong> | ||
| <em>--sources</em> | ||
|
|
||
| Lists the sources from with the current env has been compiled. | ||
|
|
||
| <em>-k</em> | <em>--keys</em> | ||
|
|
||
| Prints (top-level) keys of matching properties only | ||
|
|
||
| <em>-p</em> | <em>--properties</em> | ||
| <em>-l</em> | <em>--list</em> | ||
|
|
||
| Prints output in .properties format | ||
|
|
||
| <em>-j</em> | <em>--json</em> | ||
|
|
||
| Prints output in JSON format | ||
|
|
||
| <em>-r</em> | <em>--raw</em> | ||
|
|
||
| Prints output with minimum formatting or decoration | ||
|
|
||
| <em>-4</em> | <em>--for</em> | <em>--profile</em> <profile,...> | ||
|
|
||
| Load configuration for the specified profile(s). | ||
| The <em>development</em> profile is used by default. | ||
|
|
||
| <em>-P</em> | <em>--process-env</em> | ||
|
|
||
| Show properties from Node.js <i>process.env</i>. | ||
|
|
||
| <em>-b</em> | <em>--resolve-bindings</em> | ||
|
|
||
| Resolve remote service bindings configured via <em>cds bind</em>. | ||
| </pre> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| <!-- this file is automatically generated and updated by a github action --> | ||
| <pre class="log"> | ||
| > cds init --help | ||
|
|
||
| <strong>SYNOPSIS</strong> | ||
| <em>cds init</em> [<project>] [<options>] | ||
|
|
||
| Initializes a new project in folder ./<project>, with the current | ||
| working directory as default. | ||
|
|
||
| <strong>OPTIONS</strong> | ||
| <em>--java</em> | ||
|
|
||
| Create a CAP Java project. | ||
|
|
||
| <em>--add</em> <feature | comma-separated list of features> | ||
|
|
||
| Add one or more features while creating the project. | ||
| <feature> can be one of the following: | ||
|
|
||
| <em>completion</em> - shell completion for cds commands | ||
| <em>java</em> - creates a Java-based project | ||
| <em>nodejs</em> - creates a Node.js-based project | ||
| <em>esm</em> - ESM-compatible Node.js project | ||
| <em>tiny-sample</em> - add minimal sample files | ||
| <em>sample</em> - add sample files including Fiori UI | ||
| <em>typer</em> - type generation for CDS models | ||
| <em>typescript</em> - add minimum configuration for a bare TypeScript project | ||
| <em>handler</em> - handler stubs for service entities, actions and functions | ||
| <em>mta</em> - Cloud Foundry deployment using mta.yaml | ||
| <em>cf-manifest</em> - Cloud Foundry deployment using manifest files | ||
| <em>helm</em> - Kyma deployment using Helm charts | ||
| <em>helm-unified-runtime</em> - Kyma deployment using Unified Runtime Helm charts | ||
| <em>containerize</em> - containerization using ctz CLI | ||
| <em>multitenancy</em> - schema-based multitenancy support | ||
| <em>toggles</em> - allow dynamically toggled features | ||
| <em>extensibility</em> - tenant-specific model extensibility | ||
| <em>side-by-side-extensibility</em> - logic extensibility via extension points | ||
| <em>mtx</em> - multitenancy + toggles + extensibility | ||
| <em>xsuaa</em> - authentication via XSUAA | ||
| <em>ias</em> - authentication via IAS | ||
| <em>ams</em> - authorization via AMS | ||
| <em>hana</em> - database support for SAP HANA | ||
| <em>postgres</em> - database support for PostgreSQL | ||
| <em>sqlite</em> - database support for SQLite | ||
| <em>h2</em> - database support for H2 | ||
| <em>liquibase</em> - database migration using Liquibase | ||
| <em>redis</em> - SAP BTP Redis, Hyperscaler Option | ||
| <em>attachments</em> - SAP BTP Object Store Service | ||
| <em>malware-scanner</em> - SAP Malware Scanning Service | ||
| <em>local-messaging</em> - messaging via local event bus | ||
| <em>file-based-messaging</em> - messaging via file system | ||
| <em>enterprise-messaging</em> - messaging via SAP Enterprise Messaging | ||
| <em>enterprise-messaging-shared</em> - messaging via shared SAP Enterprise Messaging | ||
| <em>redis-messaging</em> - messaging via Redis | ||
| <em>kafka</em> - messaging via Apache Kafka | ||
| <em>approuter</em> - dynamic routing using @sap/approuter | ||
| <em>connectivity</em> - SAP BTP Connectivity Service | ||
| <em>destination</em> - SAP BTP Destination Service | ||
| <em>html5-repo</em> - SAP BTP HTML5 Application Repository | ||
| <em>portal</em> - SAP BTP Portal Service | ||
| <em>application-logging</em> - SAP BTP Application Logging Service | ||
| <em>audit-logging</em> - SAP BTP Audit Logging Service | ||
| <em>notifications</em> - SAP BTP Notification Service | ||
| <em>workzone-standard</em> - SAP BTP Work Zone, Standard Edition | ||
| <em>data</em> - add CSV headers for modeled entities | ||
| <em>http</em> - add .http files for modeled services | ||
| <em>lint</em> - configure cds lint | ||
| <em>pipeline</em> - CI/CD pipeline integration | ||
|
|
||
| <em>--java:mvn</em> <Comma separated maven archetype specific parameters> | ||
|
|
||
| Add the given parameters to the archetype call. | ||
| See <i>https://cap.cloud.sap/docs/java/developing-applications/building#the-maven-archetype</i> | ||
| for parameters supported by the archetype. | ||
|
|
||
| <em>--force</em> | ||
|
|
||
| Overwrite all files. | ||
|
|
||
| <strong>EXAMPLES</strong> | ||
| <em>cds init</em> bookshop | ||
| <em>cds init</em> bookshop --java | ||
| <em>cds init</em> bookshop --add hana | ||
| <em>cds init</em> bookshop --add multitenancy,mta | ||
| <em>cds init</em> --java --java:mvn groupId=myGroup,artifactId=newId,package=my.company | ||
|
|
||
| <strong>SEE ALSO</strong> | ||
| <em>cds add</em> - to augment your projects later on | ||
| </pre> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters