> For the complete documentation index, see [llms.txt](https://intuitem.gitbook.io/ciso-assistant/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://intuitem.gitbook.io/ciso-assistant/concepts/catalog/libraries.md).

# Libraries

A **library** is a bundled set of catalog objects — frameworks, threats, risk matrices, reference controls, mappings, security advisories, CWE entries — distributed as a YAML file.

Libraries are how content gets into CISO Assistant. They make the platform extensible: anything from a regulator's framework to a vendor's threat feed to your organisation's internal control catalogue is just another library.

## Mental model

```mermaid
graph LR
  SL[Stored library] -->|loaded as| LL[Loaded library]
  LL -.->|bundles| F[Framework]
  LL -.->|bundles| RM[Risk matrix]
  LL -.->|bundles| T[Threats]
  LL -.->|bundles| RC[Reference controls]
  LL -.->|bundles| MS[Mapping set]
  LL -->|depends on| LL
```

A library starts life as a **stored** record — its YAML is parsed and registered but contents stay inactive. Loading it materialises whatever catalog objects the YAML declares — any subset of framework, risk matrix, threats, reference controls, or mapping set (all dashed, all optional). A loaded library can also declare dependencies on other loaded libraries — for example, a framework library that ships its companion reference-control catalogue as a separate dependency.

| User-facing    | Internal                | Notes                                           |
| -------------- | ----------------------- | ----------------------------------------------- |
| Stored library | `StoredLibrary`         | Inventory entry, contents inactive              |
| Loaded library | `LoadedLibrary`         | Activated; contents visible across the platform |
| Mapping set    | `RequirementMappingSet` | Crosswalk between two frameworks                |

## Stored vs loaded

A library can be in one of two states:

* **Stored** — the library is known to the instance but its content hasn't been activated yet. It's visible in the libraries store, ready to be loaded on demand.
* **Loaded** — the library is active. Its catalog objects show up across the platform: a loaded framework becomes available when creating an audit; a loaded threat appears in the threats list; loaded reference controls power autosuggestion.

## What's in a library

A library typically contains a single primary object (for example, one framework) but may bundle related ones — a framework alongside its companion reference-control catalogue and its mapping to a sibling framework.

Library content is referenced by **URN** (Uniform Resource Name), an immutable identifier that survives renames and re-imports.

## Built-in, community, and custom

* **Built-in libraries** ship with the platform — over 100 frameworks plus the standard threat, matrix, and reference-control catalogues.
* **Community libraries** are contributed by the open-source community; see [Contributing a framework or library](/ciso-assistant/contributing/framework.md).
* **Custom libraries** can be built locally and loaded without sharing them, useful for internal frameworks or control sets.

See [Designing your own libraries](/ciso-assistant/configuration/libraries/custom-libraries.md) for the format.

## Lifecycle

Libraries are versioned. When a newer version is available, you can upgrade in place — your existing audits keep using the version they were created with until you migrate them explicitly. See [Library upgrade](/ciso-assistant/configuration/libraries/library-upgrade.md) and [Library clean-up](/ciso-assistant/configuration/libraries/library-cleanup.md).

## Related

* [Frameworks](/ciso-assistant/concepts/catalog/frameworks.md)
* [Threats](/ciso-assistant/concepts/catalog/threats.md)
* [Vocabulary → Library / Catalog object / URN](/ciso-assistant/introduction/vocabulary.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://intuitem.gitbook.io/ciso-assistant/concepts/catalog/libraries.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.