Skip to main content

A simple tool to generate a call graph for calls within Windows CMD (batch) files.

Project description

# cmd-call-graph A simple tool to generate a call graph for calls within Windows CMD (batch) files.

It takes the input file as stdin and outputs the resulting file to stdout, outputting logs and errors to stderr.

Usage example from WSL (Windows Subsystem for Linux):

$ python3 cmd-call-graph.py < your-file.cmd > your-file-call-graph.dot 2>log

The resulting dot file can be rendered with any dot renderer. Example with graphviz:

$ sudo apt install graphviz $ dot -Tpng your-file-call-graph.dot > your-file-call-graph.png $ explorer.exe your-file-call-graph.png

## Example

Here is an example CMD script:

@echo off call :foo goto :eof :bar echo “in bar” call :baz call :baz :baz echo “in baz” :foo echo “In foo” goto :bar

This script would generate the following graph:

![call graph](https://github.com/Microsoft/cmd-call-graph/raw/master/examples/example1-noshowall.png)

If the –show-all-calls option is set to True, then the following graph would be generated:

![call graph showall](https://github.com/Microsoft/cmd-call-graph/raw/master/examples/example1.png)

## Why? Sometimes legacy code bases may contain old CMD files. This tool allows to generate a visual representation of the internal calls within the script.

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Unit tests Run unit tests from the project root by running:

python3 -m unittest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cmd-call-graph-0.1.1.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distributions

cmd_call_graph-0.1.1-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

cmd_call_graph-0.1.1-py2-none-any.whl (7.2 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page