> For the complete documentation index, see [llms.txt](https://boomi.markusschmidt.pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boomi.markusschmidt.pro/boomi-console/readme/how-it-works.md).

# What is ...

*Boomi Console* is

* a command line application
* that runs on Windows, Linux and MacOS.
* written in C# (.NET 10)

<div align="left"><figure><img src="/files/85JYD4ld2Rbc85l1zkl5" alt="" width="563"><figcaption><p>Windows Console (Terminal) runs BoomiConsole Command</p></figcaption></figure></div>

*Boomi Console*

* connects to [Boomi Platform API](https://developer.boomi.com/docs/APIs/PlatformAPI/APIReference/Platform_APIs_Overview#section/Introduction/Platform-API)

to

* retrieve Components, Deployments and Package data
* to save all metadata XML to your local drive
* to transform metadata, for example, into an XML, JSON, SQL profile
* to render list and reports;

{% content-ref url="/pages/-M\_-UacHMHxEJ\_VEcOXp" %}
[Commands](/boomi-console/commands.md)
{% endcontent-ref %}

and to

* create extensive documentation
* including process UML flow diagrams.

{% content-ref url="/pages/0V1YeGR99DRQYPAlTiA5" %}
[Use-Cases](/boomi-console/command-collection.md)
{% endcontent-ref %}

and, last but not least,

* BoomiConsole is extensible and you can expect more to come..
