> For the complete documentation index, see [llms.txt](https://asus-isg-aidc.gitbook.io/guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://asus-isg-aidc.gitbook.io/guide/latest/cli/commandreference/osinfo.md).

# OS Configuration Inventory

| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/07/06    |

## Table of Contents

* [1. Overview](#overview)
* [2. Views](#views)
* [3. Common Flags](#common-flags)
* [4. Usage Examples](#usage-examples)

***

## 1. Overview <a href="#overview" id="overview"></a>

{% hint style="warning" %}
**⚠️ Prerequisite: `aidc-cli init` required first**

This command depends on settings saved by [`aidc-cli init`](/guide/latest/cli/commandreference/init.md). Before running it, make sure you have completed:

* [`aidc-cli init inventory`](/guide/latest/cli/commandreference/init.md#inventory) — render the node inventory from `aidc.csv`
* SSH access to the nodes — [`aidc-cli deploy install`](/guide/latest/cli/commandreference/deploy.md) sets this up during OS deployment; for nodes that already have an OS, run [`aidc-cli deploy access-key`](/guide/latest/cli/commandreference/deploy.md) or fill the `password` column in `aidc.csv`

For the full setup sequence, see the [Getting Started](/guide/latest/cli/gettingstarted.md) guide.
{% endhint %}

The `osinfo` command collects operating system configuration inventory data from target nodes.

```bash
aidc-cli osinfo <brief|summary> [flags]
```

***

## 2. Views <a href="#views" id="views"></a>

| Subcommand | Description                                   |
| ---------- | --------------------------------------------- |
| `brief`    | Collect a compact OS configuration inventory  |
| `summary`  | Collect a normalized OS configuration summary |

***

## 3. Common Flags <a href="#common-flags" id="common-flags"></a>

Both `osinfo` views support the following flag:

| Flag       | Short | Required | Description                                                                              |
| ---------- | :---: | :------: | ---------------------------------------------------------------------------------------- |
| `--stdout` |   —   |     ❌    | Output the raw OS inventory JSON to stdout instead of only saving the generated artifact |

***

## 4. Usage Examples <a href="#usage-examples" id="usage-examples"></a>

```bash
# Collect the brief OS inventory view
aidc-cli osinfo brief

# Collect the normalized OS inventory summary
aidc-cli osinfo summary

# Output the summary view to stdout as JSON
aidc-cli osinfo summary --stdout

# Collect OS inventory for selected nodes only
aidc-cli osinfo brief -l node01,node02
```