cs-icon.svg

Contentstack .NET Model Generator

This utility is used to generate models based on content types in stack.

Installation

To install Contenstack Model Generator, run following command:

dotnet tool install --global contentstack.model.generator

If you want to update your Model Generator, use the following:

dotnet tool update --global contentstack.model.generator

Note: In the above command, if you skip version, you will still be able to download the latest version of the Model Generator.

Use the Model Generator

Once you install the Contentstack Model Generator utility, run --help to view the list of available commands. The following table lists the shortcut keys for running specific operations:

Short keyLong KeyDescription
-a--api-keyThe stack API key for the Content Management API

-A

--authtoken

The authtoken for the Content Management API
-e--endpointThe Contentstack host for the Content Management API
-n--namespaceThe namespace the classes should be created in
-f--forceAutomatically overwrites files that already exist
-m--modular-block-prefixThe modular block class prefix
-g--group-prefixThe group class prefix
-p--pathPath of the file or a directory to create files in

Example 1

To create classes in the current directory, run the following command:

contentstack.model.generator -a <stack_api_key> -A <authtoken>

Example 2

To create classes in a specific path, run the following command:

contentstack.model.generator -a <stack_api_key> -A <authtoken> -p /User/xxx/Desktop

Example 3

To create classes with namespace, run the following command:

contentstack.model.generator -a <stack_api_key> -A <authtoken> -n YourProject.Models

Reference

For more details, refer to our GitHub page.

More resources

Was this article helpful?
^