apigenie init
Sets a repository up for API Genie and for coding agents: writes apigenie.yaml with the lint
rules of the API descriptions it finds, and adds the section that tells coding agents how to check
them to AGENTS.md.
Usage
apigenie init [DIR] [--ruleset recommended|strict|all] [--agents-file FILE] [--no-agents] [--dry-run] [--json]
apigenie init
apigenie init --ruleset strict --agents-file CLAUDE.md
Description
init works on the repository that holds DIR (the current directory by default): the
directory of the configuration file the other commands would read there, else the root of its
git repository, or DIR itself outside git. It finds the API descriptions in it as
apigenie-catalog does (the files git lists, OpenAPI, Swagger 2.0,
AsyncAPI, Protobuf and GraphQL), lists them, and writes two files at the root:
apigenie.yaml, unless the repository has a configuration file already, which is kept as it is. The new file has the linter extend--ruleset(recommendedby default) for OpenAPI and for each other family found, andformatanddifftheir recommended settings. It names its JSON Schema for editors.- The section “API descriptions” for coding agents, the one the guide
Work with AI agents shows: in
AGENTS.md, or the file of--agents-file(CLAUDE.md,.github/copilot-instructions.md, …). A new file gets the section; a file without it gets it appended; a file with a line## API descriptionsis kept. The section takes the file’s line endings.--no-agentsleaves the file alone.
Running init again changes nothing. --dry-run prints what it would write and writes nothing.
Commit both files, so that every agent and every CI run use the same rules.
Options
| Option | Description |
|---|---|
--ruleset NAME |
recommended (default), strict or all: the ruleset the linter extends for every family. |
--agents-file FILE |
The instructions file of the coding agents, relative to the repository and inside it (default AGENTS.md). |
--no-agents |
Write no instructions for coding agents. |
--dry-run |
Print what would be written, and write nothing. |
--git PATH |
The git program (default git). |
--json |
Print the report (apigenie-init-report.json): the root, each file with its outcome (created, updated, kept, skipped) and the API descriptions found. |
Exit status
| Status | Meaning |
|---|---|
| 0 | The repository is set up (or, with --dry-run, would be). |
| 2 | A usage error, a directory that doesn’t exist, or git failed. |
These are the statuses of every command (exit status).
See also
- Configuration: the sections of
apigenie.yaml. - Work with AI agents: what the section asks of an agent.
apigenie-catalog init: thecatalogsection ofapigenie.yaml.