# AGENTS.md

The open-source, cross-platform API client for GraphQL, REST, WebSockets, SSE and gRPC. With Cloud, Local and Git storage.

## Setup

```
npm ci
```

## Commands

```
npm run dev                        # run locally
npm run test                       # run the test suite, must pass before any commit
npm run lint                       # lint
npm run dev:autoRestart
npm run type-check
npm run clean
npm run install-libcurl-electron
npm run install-libcurl-node
```

## Layout

- `packages/` 1621 source files
- `examples/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/resolve-previous-release-tag.test.js`.
- CI defines what passing means. See `.github/workflows/homebrew.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/insomnia/bin/yarn-standalone.js` is 4580KB. It will not fit comfortably in context, so read it in parts.

---

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.