API Genie CLI streamlines Web API development by providing a command-line interface for managing and generating artifacts from OpenAPI schemas.

Key functionality

SubcommandDescription
diffCompares schemas, detects changes, generates changelogs
formatFormats schemas to your team’s standards
generateGenerates code/artifacts from schemas
lintValidates schemas for best practices
serverStarts a development API server

Supported file formats

Input to most CLI commands are one or more OpenAPI schemas. All commands recognize schemas in JSON or YAML formats.

Configuration files

Apart from OpenAPI schemas, most CLI commands also accept input from configuration file. The file contains configuration for commands, based on best practices and guidelines in your organization.

See the configuration section for detailed description of this file.

Telemetry

API Genie CLI collects anonymous usage data to help us improve the tool and provide a better user experience. This data is essential for understanding how users interact with the CLI and identifying areas for improvement.

The telemetry data is limited to technical details about how you use the CLI, such as:

  • Version of the CLI
  • Commands used
  • Performance metrics for internal tasks (e.g., time taken to parse YAML files)
  • Errors encountered by users (anonymized)

No personal information is collected. This includes usernames, API keys, or any data specific to your API interactions.

The collected data is used for:

  • Identifying common usage patterns and workflows
  • Debugging and resolving technical issues
  • Prioritizing feature development based on user needs

Currently, the telemetry data is stored locally in a file named .apigenie.telemetry. You can safely ignore this file. In the future, we will offer an opt-in feature that allows you to contribute your anonymized telemetry data to help us improve the tool.