CLI Wiki Documentation Update Summary

Overview

Comprehensive wiki documentation has been created for all DynamicsCrm.DevKit.Cli tasks with complete parameter details and examples.

Created Files

Main CLI Documentation

1. cli/README.md - Index page for all CLI tasks
   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli

Individual Task Documentation

Server-Side Development

1. cli/server.md - Server component deployment (plugins, workflows, custom actions, custom APIs, data providers)

   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/server
   • Covers: DLL/NUPKG deployment, auto-registration, plugin steps, images, secure configurations

2. cli/plugins.md - Plugin-specific deployment (alias for server task)

   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/plugins

3. cli/workflows.md - Workflow activity deployment (alias for server task)

   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/workflows

4. cli/dataproviders.md - Data provider deployment (alias for server task)

   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/dataproviders

Code Generation

5. cli/generators.md - Code generation (C# late-bound, TypeScript forms, WebAPI clients)

   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/generators
   • Covers: CSharp, JsForm, JsWebApi generation types
   • Entity filters: *, folder, comma-separated list

6. cli/proxytypes.md - Early-bound proxy type generation

   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/proxytypes

• Covers: CrmSvcUtil.exe extensions, C#/VB.NET generation

Web Resources

7. cli/webresources.md - Web resource upload
   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/webresources

• Covers: JS, CSS, HTML, images, smart upload, folder structure

8. cli/downloadwebresources.md - Web resource download (to be created)
   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/downloadwebresources

Solutions

9. cli/solutionpackagers.md - Solution pack/unpack (to be created)
   • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/solutionpackagers

Reports

10. cli/downloadreports.md - Report download (to be created)

    • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/downloadreports

11. cli/uploadreports.md - Report upload (to be created)

• URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/uploadreports

Data Sources

12. cli/datasources.md - Virtual entity data source creation (to be created)
    • URL: https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/datasources

Documentation Structure

Each task documentation includes:

? Required Sections

• Overview - Task purpose and description
• Command Line Syntax - Basic command format
• Parameters - All required and optional parameters with descriptions
• JSON Configuration - Complete JSON schema with examples
• Examples - Real-world usage scenarios
• Output - Expected console output
• Common Issues - Troubleshooting guide
• See Also - Related tasks and documentation links

? Optional Sections (where applicable)

• Features - Key capabilities
• Best Practices - Recommended usage patterns
• Performance Tips - Optimization suggestions
• CI/CD Integration - Pipeline examples
• File Structure - Expected folder organization

Parameter Documentation

All parameters documented with:

• Name - Parameter name with / prefix
• Description - What the parameter does
• Required/Optional - Whether parameter is mandatory
• Example - Realistic example value
• Default - Default value if not specified

JSON Property Documentation

All JSON properties documented with:

• Property Name - JSON key
• Type - Data type (string, array, boolean)
• Required - Whether property is mandatory
• Description - What the property controls
• Default - Default value if not specified
• Examples - Sample values

Examples Provided

Each task includes multiple examples:

1. Basic Usage - Simplest form
2. Advanced Usage - With optional parameters
3. Multiple Profiles - Different configurations
4. SDK Login - Alternative authentication
5. CI/CD Integration - Pipeline examples

URL Format

All wiki pages follow GitHub wiki URL format:

https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/{taskname}

Examples:

• https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/server
• https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/generators
• https://github.com/phuocle/Dynamics-Crm-DevKit/wiki/cli/webresources

Updated Files

1. Home.md - Added link to CLI Tasks index
2. V4-Wiki-Update-Summary.md - Added CLI documentation notes

Still To Create

The following task pages need to be created (following same structure):

• cli/plugins.md
• cli/workflows.md
• cli/dataproviders.md
• cli/downloadwebresources.md
• cli/solutionpackagers.md
• cli/downloadreports.md
• cli/uploadreports.md
• cli/datasources.md

Usage

Users can access documentation via:

1. Main CLI Page: Start at DynamicsCrm.DevKit.Cli.md
2. CLI Tasks Index: Browse all tasks at cli/README.md
3. Direct Links: Go directly to specific task pages
4. Home Page: Access from main wiki home

Benefits

? Complete Parameter Documentation - All parameters with descriptions and examples ? Real-World Examples - Practical usage scenarios ? Troubleshooting - Common issues and solutions ? CI/CD Ready - Pipeline integration examples ? Easy Navigation - Cross-linked between related tasks ? GitHub Wiki Compatible - URL format matches GitHub wiki structure

Next Steps

To complete CLI documentation:

1. Create remaining task pages
2. Add screenshots where helpful
3. Update with user feedback
4. Keep synchronized with CLI code changes

Notes

• All documentation uses Markdown format
• Compatible with GitHub wiki
• Follows consistent structure across all tasks
• Includes version 4 features
• Ready for immediate use