# Documentation

Source: https://apigenie.pl/docs

Learn API Genie with the Quickstart, the guides and the concepts, look up every command in the reference, and read what each linter rule checks. Every page of Docs has a Markdown copy at the same address plus `.md`; /llms.txt lists them.

## Get started

Install the CLI and run the first commands on an API you have, a new one, or a set of APIs to keep consistent.

- [Quickstart](/docs/quickstart.md)

## How-to guides

One job each, from the first command to CI. All of them: [How-to guides](/docs/guides.md).

- [Lint and format API descriptions](/docs/guides/lint-and-format-api-descriptions.md)
- [Catch breaking changes in CI](/docs/guides/catch-breaking-changes-in-ci.md)
- [Generate a client and a server](/docs/guides/generate-a-client-and-a-server.md)
- [Mock and contract-test an API](/docs/guides/mock-and-contract-test-an-api.md)
- [Publish API documentation](/docs/guides/publish-api-documentation.md)
- [Edit an API in forms](/docs/guides/edit-an-api-in-forms.md)
- [Catalog the APIs of a repository](/docs/guides/catalog-the-apis-of-a-repository.md)
- [Work with AI agents](/docs/guides/work-with-ai-agents.md)

## Coming from another tool

What changes, what stays and what has no counterpart when a repository moves to API Genie. All of them: [Coming from another tool](/docs/guides.md#coming-from-another-tool).

- [Migrate from Spectral](/docs/guides/migrate-from-spectral.md)
- [Migrate from Prism](/docs/guides/migrate-from-prism.md)
- [Migrate from OpenAPI Generator](/docs/guides/migrate-from-openapi-generator.md)
- [Migrate from Buf](/docs/guides/migrate-from-buf.md)
- [Migrate from Redocly CLI](/docs/guides/migrate-from-redocly.md)
- [Migrate from oasdiff](/docs/guides/migrate-from-oasdiff.md)

## Concepts

How the tools decide, each explained with a document to try it on: the mock's answers, the proxy's checks, the configuration file and the catalog.

- [How the mock picks a response](/docs/concepts/how-the-mock-picks-a-response.md)
- [What the validating proxy checks](/docs/concepts/what-the-proxy-checks.md)
- [Where apigenie.yaml is found and how settings merge](/docs/concepts/where-the-configuration-is-found.md)
- [What the catalog counts as a specification](/docs/concepts/what-the-catalog-counts-as-a-specification.md)
- [The compatibility promise](/docs/reference/cli/compatibility.md)

## Reference

Every command, option and setting, by product.

- [CLI](/docs/reference/cli.md): `apigenie`
- [Generator](/docs/reference/generator.md): `apigenie-generator`
- [Server](/docs/reference/server.md): `apigenie-server`
- [Catalog](/docs/reference/catalog.md): `apigenie-catalog`
- [Editor](/docs/reference/editor/hosts.md)

## CI

Lint, format and diff in every pull request, on any system. All of them: [CI](/docs/ci.md).

- [GitHub Action](/docs/ci/github-action.md)
- [GitLab CI](/docs/ci/gitlab.md)
- [Azure Pipelines](/docs/ci/azure-pipelines.md)
- [Jenkins](/docs/ci/jenkins.md)
- [CircleCI](/docs/ci/circleci.md)
- [Bitbucket Pipelines](/docs/ci/bitbucket-pipelines.md)

## Linter rules

What each rule of apigenie lint checks and why, and the rulesets that turn them on. All of them: [Linter rules](/docs/linter.md).

- [OpenAPI: 64 rules](/docs/linter/openapi.md)
- [AsyncAPI: 34 rules](/docs/linter/asyncapi.md)
- [Swagger 2.0: 48 rules](/docs/linter/swagger.md)
- [GraphQL: 87 rules](/docs/linter/graphql.md)
- [Protobuf: 39 rules](/docs/linter/protobuf.md)

## Help

The questions teams ask before adopting, and what to do when a command misbehaves.

- [FAQ](/docs/faq.md)
- [Troubleshooting](/docs/troubleshooting.md)

## Changelog

What changed in each release of the CLI.

- [Changelog](/changelog.md)