# Introduction

The Developer Cookbook is a collection of practical, high-impact recipes designed to help you extend, customize, and build on top of the OpenMind platform. If the Quickstart shows you how to use OM1, this Cookbook shows you how to build with it.

Here's what you can do with OM1

1. Build a new config file
2. Introduce a new mode
3. Configure a new Input Plugin

Before building with OM1, make sure you've completed the [Getting Started](https://github.com/OpenMind/OM1/blob/main/docs/developing/1_get-started/README.md) guide and have OM1 installed. Understand the important concepts and components that are part of OM1.

Then dive into any recipe that interests you!

### Development workflow

#### Linting and Testing (Mandatory)

To check/format/lint your code before committing, install [pre-commit](https://pre-commit.com/) and execute `pre-commit install`. This ensures that pre-commit checks run before each commit.

Additionally, you can manually trigger all checks by running

```bash
pre-commit run --all-files
```

#### Unit Testing

To unit test the system, run:

```bash
uv run pytest --log-cli-level=DEBUG -s
```

Use type `hints` and `docstrings` for better code maintainability.


---

# 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://docs.openmind.com/developer-cookbook/introduction.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.