# AGENTS.md

Open Data Platform for analysts, quants and AI agents.

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `openbb_platform/` 1217 source files
- `desktop/`         70 source files
- `cli/`             51 source files
- `cookiecutter/`    18 source files
- `examples/`        3 source files
- `build/`           2 source files

## Conventions

- Tests live alongside the code they cover, following `cli/integration/test_commands.py`.
- CI defines what passing means. See `.github/workflows/build-desktop-osx64.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `openbb_platform/providers/sec/openbb_sec/utils/html2markdown.py` is 325KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.