AGENTS.md

1Firecrawl is a web scraper API. The directory you have access to is a monorepo:
2 - `apps/api` has the actual API and worker code
3 - `apps/*-sdk` are various SDKs
4 
5When making changes to the API, here are the general steps you should take:
61. Write some end-to-end tests that assert your win conditions, if they don't already exist
7  - 1 happy path (more is encouraged if there are multiple happy paths with significantly different code paths taken)
8  - 1+ failure path(s)
9  - Generally, E2E (called `snips` in the API) is always preferred over unit testing.
10  - In the API, always use `scrapeTimeout` from `./lib` to set the timeout you use for scrapes.
11  - These tests will be ran on a variety of configurations. You should gate tests in the following manner:
12    - If it requires fire-engine: `!process.env.TEST_SUITE_SELF_HOSTED`
13    - If it requires AI: `!process.env.TEST_SUITE_SELF_HOSTED || process.env.OPENAI_API_KEY || process.env.OLLAMA_BASE_URL`
142. Write code to achieve your win conditions
153. Run your tests using `pnpm harness jest ...`
16  - `pnpm harness` is a command that gets the API server and workers up for you to run the tests. Don't try to `pnpm start` manually.
17  - The full test suite takes a long time to run, so you should try to only execute the relevant tests locally, and let CI run the full test suite.
184. Push to a branch, open a PR, and let CI run to verify your win condition.
19Keep these steps in mind while building your TODO list.