# 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..


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://boomi.markusschmidt.pro/boomi-console/readme/how-it-works.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.