CSharpTest.Net
CmdTool.exe Overview
Send Feedback Download Help File
Command-Line Tools > CmdTool.exe Overview

Glossary Item Box

Usage:

C:\> CmdTool.exe COMMAND [arguments]

Visual Studio code generator that supports any command-line right from Visual Studio 2005-2010.  CmdTool has a complete command-line interface as well for integration into builds you can easily regenerate all your code in one simple command-line operation.

Most commands require a search pattern or base directory to locate projects.  For each project located in that set CmdTool will crawl the contents and find any project items bound to the "CmdTool" custom tool, then for each project and source file it:

  1. Scans up the directory tree from the source file to locate all "CmdTool.config" files.
  2. Loads the exe's configuration file.
  3. Looks for any matches on the source file's name based on the configuration files loaded.
  4. Assuming your building, it then runs each process in sequence capturing the output.
  5. If the specific tool has indicated to capture the output as the generator result it will be written to the generated file.
  6. When running in Visual Studio, errors and other progress information will be written to the Output Window.

Options:

Commands:

build

Rebuilds the output generated by the projects specified.

Usage:

C:\> CmdTool.exe BUILD project-file 

Arguments:

  • project-file - One or more project files or wild-card patterns that specify the locations to recursively search for projects.

clean

Removes all output generated by the projects specified.

Usage:

C:\> CmdTool.exe CLEAN project-file 

Arguments:

  • project-file - One or more project files or wild-card patterns that specify the locations to recursively search for projects.

Help

Gets the help for a specific command or lists available commands.

Usage:

C:\> CmdTool.exe HELP [[/name=]String] [/html]

Arguments:

  • [[/name=]String] - The name of the command or option to show help for.
  • [/html] = (False) - Output the full help content to HTML and view in the local browser.

help-config

Outputs a sample configuration file that demonstrates the available options.

Usage:

C:\> CmdTool.exe HELP-CONFIG

help-vars

Outputs the available replacement variables for the first generated file in the provided project.

Usage:

C:\> CmdTool.exe HELP-VARS project-file

Arguments:

  • project-file - One or more project files or wild-card patterns that specify the locations to recursively search for projects.

register

Registers the CmdTool custom generator with Visual Studio 2005, 2008, and 2010.

Usage:

C:\> CmdTool.exe REGISTER 

unregister

Removes the CmdTool custom generator from Visual Studio 2005, 2008, and 2010.

Usage:

C:\> CmdTool.exe UNREGISTER 

Generated with Document! X 2011 by Innovasys