Was this article helpful?
Thanks for your feedback
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 --version 0.4.1
In case you need to update your Model Generator, use the following:
dotnet tool update --global contentstack.model.generator --version 0.4.1
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 Contentstack Model Generator utility, run --help to view available commands. The following table lists the shortcut keys for running specific operations:
| Short key | Long Key | Description |
| -a | --api-key | The Stack API key for the Content Management API |
-A | --authtoken | The Authtoken for the Content Management API |
| -e | --endpoint | The Contentstack Host for the Content Management API |
| -n | --namespace | The namespace the classes should be created in |
| -f | --force | Automatically overwrite files that already exist |
| -m | --modular-block-prefix | The Modular block Class Prefix |
| -g | --group-prefix | The Group Class Prefix |
| -p | --path | Path to the file or 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
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.
