https://github.com/contentstack/contentstack-model-generator
Generates a model of Contentstack's content types for .Net
https://github.com/contentstack/contentstack-model-generator
Last synced: 28 days ago
JSON representation
Generates a model of Contentstack's content types for .Net
- Host: GitHub
- URL: https://github.com/contentstack/contentstack-model-generator
- Owner: contentstack
- License: mit
- Created: 2019-07-18T05:31:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-12T12:35:04.000Z (30 days ago)
- Last Synced: 2026-01-12T18:01:06.705Z (30 days ago)
- Language: C#
- Size: 1.37 MB
- Stars: 1
- Watchers: 8
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://www.contentstack.com/)
# Contentstack model generator
This utility is use to generate models based on ContentTypes in Stack.
## Installation
To install Contenstack model generator run following command:
```
dotnet tool install -g contentstack.model.generator
```
## How to use
Once you install ```contentstack.model.generator``` run ```--help``` to view available commands.
### Authentication Methods
The Contentstack Model Generator supports two authentication methods:
1. **Traditional Authtoken Authentication** (default)
2. **OAuth 2.0 Authentication**
### Command Line Options
| 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 (required for traditional auth) |
| `-b` | `--branch` | The branch header in the API request to fetch or manage modules located within specific branches. |
| `-e` | `--endpoint` | The Contentstack Host for the Content Management API |
| `-n` | `--namespace` | The namespace the classes should be created in |
| `-N` | `--is-nullable` | The features that protect against throwing a System.NullReferenceException can be disruptive when turned on. |
| `-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. |
### OAuth 2.0 Options
| Long Key | Description |
| -- | -- |
| `--oauth` | Enable OAuth 2.0 authentication (mutually exclusive with traditional auth) |
| `--client-id` | OAuth Client ID (required for OAuth) (Default Value: Ie0FEfTzlfAHL4xM ) |
| `--client-secret` | OAuth Client Secret (optional for public clients using PKCE) |
| `--redirect-uri` | OAuth Redirect URI (required for OAuth) (Default Value: http://localhost:8184 ) |
| `--app-id` | OAuth App ID (optional) ( Default Value: 6400aa06db64de001a31c8a9 ) |
| `--scopes` | OAuth Scopes (optional, space-separated) |
## Examples
### Traditional API Key Authentication
#### Example 1: Basic Usage
To create classes in current directory run following command:
```
contentstack.model.generator -a -A
```
#### Example 2: Specific Path
To create classes in specific path run following command:
```
contentstack.model.generator -a -A -p /User/xxx/Desktop
```
#### Example 3: With Namespace
To create classes with namespace run following command:
```
contentstack.model.generator -a -A -n YourProject.Models
```
#### Example 4: With Nullable Annotations
To allow `Nullable` annotation context in model creation run following command:
```
contentstack.model.generator -a -A -N
```
### OAuth 2.0 Authentication
#### Example 5: OAuth with PKCE (Recommended)
For public clients or enhanced security, use OAuth with PKCE:
```
contentstack.model.generator --oauth -a --client-id --redirect-uri http://localhost:8184
```
#### Example 6: OAuth with Client Secret
For confidential clients with client secret:
```
contentstack.model.generator --oauth -a --client-id --client-secret --redirect-uri http://localhost:8184
```
#### Example 7: OAuth with App ID
For OAuth with specific app:
```
contentstack.model.generator --oauth -a --client-id --redirect-uri http://localhost:8184 --app-id
```
#### Example 8: OAuth with Custom Path and Namespace
```
contentstack.model.generator --oauth -a --client-id --redirect-uri http://localhost:8184 -p /path/to/models -n YourProject.Models
```
## OAuth Command Example
Here's what you'll see when running an OAuth command:
```bash
$ contentstack.model.generator --oauth -a --client-id myclient123 --redirect-uri http://localhost:8184
Contentstack Model Generator v0.5.0
=====================================
OAuth Authentication Required
=============================
Please open the following URL in your browser to authorize the application:
https://app.contentstack.com/#!/apps/6400aa06db64de001a31c8a9/authorize?response_type=code&client_id=myclient123&redirect_uri=http%3A%2F%2Flocalhost%3A8184&code_challenge=...
After authorization, you will be redirected to a local URL.
Please copy the 'code' parameter from the redirect URL and paste it here:
Authorization code: [User pastes the code here]
Exchanging authorization code for access token...
OAuth authentication successful!
Access token expires at: 2024-01-15 14:30:00 UTC
Fetching stack information...
Stack: My Contentstack Stack
API Key: api_key
Fetching content types...
Found 5 content types:
Generating files from content type
Files successfully created!
Opening /Models
Logging out from OAuth...
OAuth logout successful!
```
### MIT License
Copyright (c) 2012-2026 Contentstack
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.