> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnichar.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Read .char files from the command line

> The omnichar-sdk command inspects a .char, extracts its files, prints prompt text and writes a reference sheet, so tools in any language can read characters.

Installing [the Python SDK](/integrations/python-sdk) also installs an `omnichar-sdk` command.

```bash theme={null}
pip install omnichar-sdk
```

## Inspect a character

```bash theme={null}
omnichar-sdk inspect Ada.char
```

```text theme={null}
Ada  (2 references, format 1)

Ada, a woman in her thirties with short dark hair and a scar through her left eyebrow.

references: 1 body, 1 face
reference sets: flux2-klein
adapter z-image: rank 16, 600 steps, strength 0.8
  partial: Z-Image adapter keys match 210 of 238 module stems. The remaining 12 percent will not be applied, so the result is a near miss rather than a failure.
hint: Add a profile view.
```

Add `--json` to print the whole character record. A tool in any language can read a `.char` this way without a Python binding.

```bash theme={null}
omnichar-sdk inspect Ada.char --json
```

## Extract its files

Writes the references, the description and any adapters into a folder: `refs/000_face.png`, `description.md`, `Ada-z-image.safetensors` and so on.

```bash theme={null}
omnichar-sdk extract Ada.char -o out/
```

## Print prompt text

```bash theme={null}
omnichar-sdk prompt Ada.char --style token
```

`--style` takes `ordinal`, `token`, `at-image` or `description-only`. See [Prompt text](/integrations/python-sdk#prompt-text) for which model reads which. `--first-position`, `--arch` and `--role-lines` match the Python options.

## Write a reference sheet

```bash theme={null}
omnichar-sdk sheet Ada.char -o ada.png
```

Takes `--arch`, `--role`, `--max-references`, `--first-position` and `--columns`. Needs the `images` extra: `pip install 'omnichar-sdk[images]'`.


## Related topics

- [Read .char files with the Python SDK](/integrations/python-sdk.md)
- [The .char character file](/characters.md)
- [Omnichar Studio command-line options](/app/command-line.md)
- [Integrate .char characters into your tools](/integrations/overview.md)
- [Get started with Omnichar Studio](/app/getting-started.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.