# Components in a Folder

It can be very useful to work with components which are located in a specific folder, only. For example an API, where an API component (web-service) and two processes implementing the API end-points are located in the same folder.

```url
/#Examples/95 - Documentation Examples/#APIServices/GPR - GoodPractices
```

<figure><img src="/files/ci5OJcm6AmYKFu2jS6hd" alt=""><figcaption><p>A Web-Service and its implementation in a single folder.</p></figcaption></figure>

### Create documentation

Create documentation for all *deployable* components in the specified folder, and write the output to *GoodPractices.*

```batch
.\bc comp doc /deployableOnly /f "*GPR - GoodPractices*" /o GoodPractices
```

You will find the rendered documentation in the specified output folder *GoodPractices/Doc:*

<figure><img src="/files/lZElqAOMhdoNaijNeoLh" alt=""><figcaption><p>A nice documentation for all processes found in <code>GPR - GoodPractices</code> folder.</p></figcaption></figure>

The documentation is interactive (see [Documentation Links](/boomi-console/help-text/documentation-links.md)).

<figure><img src="/files/TeVSqAt3G2G4D5kCI5fI" alt=""><figcaption><p>From documentation to Runtime using interactive links</p></figcaption></figure>

### Get deployment overview

Get all deployed components which are located in the specified folder and render the *deployedPackage.csv* to see which version was deployed to which environment.

Write the output to *GoodPractices.*

```batch
.\bc deploy get /f "*GPR - GoodPractices*" /t deployedPackages.csv /o GoodPractices
```

Depending on the CSV Viewer you chose (VS Code Extension: *Excel Viewer* or *Rainbow CSV*), you will probably get something like this:

<figure><img src="/files/hr9HrribYKW50eo3XmyO" alt=""><figcaption><p>The <em>deployedPackages.csv</em> shows components deployed to any environment incl. their deployment details.</p></figcaption></figure>

## Arguments explained

* `/f *{folderName}*`\
  The folder-name with wild-cards as the component source. The wildcarded name is used to lookup the folder full path.
* `/o`\
  The directory where all outputs will be written to, relative to the workspace directory!\
  It is recommended to use `out\{folderName}`
* `/t compList.CSV`\
  A predefined template to render the component output.

  <figure><img src="/files/D5yXIngDI6VRDhAV7jDV" alt=""><figcaption><p><code>compList.csv</code></p></figcaption></figure>

## Observations

{% hint style="danger" %}
**Unspecified fault message**

On one Boomi Account I got *Unspecified fault message* when querying folders from API and so far there is no explanation for that.
{% endhint %}


---

# 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/command-collection/components-in-a-folder.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.