-
Notifications
You must be signed in to change notification settings - Fork 16
Configuration
DynamicsCrm.DevKit uses three solution-level configuration files. They live in the root folder of the Visual Studio solution or near the command execution folder, depending on the tool.
| File | Used by | Purpose |
|---|---|---|
DynamicsCrm.DevKit.json |
VSIX | Saved Dataverse connections for the Visual Studio extension. |
DynamicsCrm.DevKit.Cli.json |
CLI and VSIX-generated scripts | Deployment, generation, download, upload, modelbuilder, solution packager, and data source profiles. |
DynamicsCrm.DevKit.Config.json |
VSIX | Web resource file mappings and custom T4 template overrides. |
- DynamicsCrm.DevKit.json stores named Dataverse connections and the default VSIX connection.
-
DynamicsCrm.DevKit.Cli.json stores named CLI profiles used by
devkitcommands. - DynamicsCrm.DevKit.Config.json stores VSIX web resource mappings and custom T4 template overrides.
The CLI command surface itself is documented in DynamicsCrm.DevKit.Cli. Authentication options are documented in Connection.
Important
Do not add DynamicsCrm.DevKit.json to git when it contains real Dataverse connections. The file can contain encrypted Password and ClientSecret values. Those values are encrypted for convenience, but the decryption logic is part of the public DevKit source code, so this file must still be treated as sensitive developer-local configuration. See Connection for the connection storage warning.
Use DynamicsCrm.DevKit.json for local Visual Studio connection profiles only. Keep it out of source control unless every connection in the file is intentionally non-sensitive sample data.
Use DynamicsCrm.DevKit.Cli.json as project automation configuration. This file is normally committed because it defines repeatable profiles for server deployment, web resources, generators, reports, modelbuilder, solution packager, and data source commands.
Use DynamicsCrm.DevKit.Config.json when the VSIX needs to remember local file mappings or custom T4 templates. Whether to commit it depends on the team workflow: web resource mappings can be useful in a shared solution, while personal template experiments should usually stay local.
| Need | Go to |
|---|---|
| Save and reuse Dataverse connections in Visual Studio | DynamicsCrm.DevKit.json |
Configure devkit server, webresource, generator, solution, modelbuilder, reports, or data sources |
DynamicsCrm.DevKit.Cli.json |
Understand devkit command options and auth priority |
DynamicsCrm.DevKit.Cli |
| Map a local web resource file to a Dataverse web resource | DynamicsCrm.DevKit.Config.json |
| Save custom T4 templates from the VSIX UI | DynamicsCrm.DevKit.Config.json |