Last updated



The stats command provides statistics about the structure of one or more API description files. This command generates statistics for the following metrics:

  • References
  • External Documents
  • Schemas
  • Parameters
  • Links
  • Path Items
  • Operations
  • Tags

If you're interested in the technical details, the statistics are calculated using the counting logic from the StatsVisitor module.


redocly stats <api>
redocly stats <api> [--format=<option>] [--config=<path>]
redocly stats --version


apistringREQUIRED. Path to the API description file that you want to split into a multi-file structure.
--configstringSpecify path to the configuration file.
--formatstringFormat for the output.
Possible values: stylish, json, markdown.
--helpbooleanShow help.
--lint-configstringSpecify the severity level for the configuration file.
Possible values: warn, error, off. Default value is warn.
--versionbooleanShow version number.



The stats command behaves differently depending on how you pass the API to it and whether the configuration file exists.

Pass an OpenAPI file

You can use the stats command with an OpenAPI description directly, with a command like the following:

redocly stats openapi/openapi.yaml

In this case, stats shows statistics for the API description that was passed to the command.

Use an API alias in the configuration file

Instead of full paths, you can use API names from the apis section of your Redocly configuration file. With a redocly.yaml file containing the following entry for core@v1:

    root: ./openapi/api-description.json

You can obtain the stats by giving the API alias name, as shown below:

redocly stats core@v1

In this case, after resolving the path behind the core@v1 name, stats displays statistics for the openapi/api-description.json file.

Custom configuration file

By default, the CLI tool looks for the Redocly configuration file in the current working directory. Use the optional --config argument to provide an alternative path to a configuration file.

redocly stats --config=./another/directory/config.yaml


Stylish (default)

The default output format for stats is called "stylish". It outputs a nice format for your terminal, as shown in the following example:

Document: museum.yaml stats:

🚗 References: 35
📦 External Documents: 0
📈 Schemas: 23
👉 Parameters: 6
🔗 Links: 0
➡️  Path Items: 5
👷 Operations: 8
🔖 Tags: 3

museum.yaml: stats processed in 4ms

In this format, stats shows the statistics in condensed but readable output with colored text and an icon at the beginning of each line.


Add --format=json to get a machine-readable output format. The JSON format outout is great when you want to grab the stats data to use elsewhere. An example of the format is shown in the following example:

  "refs": {
    "metric": "🚗 References",
    "total": 35
  "externalDocs": {
    "metric": "📦 External Documents",
    "total": 0
  "schemas": {
    "metric": "📈 Schemas",
    "total": 23
  "parameters": {
    "metric": "👉 Parameters",
    "total": 6
  "links": {
    "metric": "🔗 Links",
    "total": 0
  "pathItems": {
    "metric": "➡️  Path Items",
    "total": 5
  "operations": {
    "metric": "👷 Operations",
    "total": 8
  "tags": {
    "metric": "🔖 Tags",
    "total": 3

You can use the JSON output to pass to another program.


Add --format=markdown and the command returns output that you can use in Markdown files or other Markdown-friendly applications. It uses a table format; there are examples of the source and the formatted output below:

| Feature  | Count  |
| --- | --- |
| 🚗 References | 35 |
| 📦 External Documents | 0 |
| 📈 Schemas | 23 |
| 👉 Parameters | 6 |
| 🔗 Links | 0 |
| ➡️  Path Items | 5 |
| 👷 Operations | 8 |
| 🔖 Tags | 3 |
🚗 References35
📦 External Documents0
📈 Schemas23
👉 Parameters6
🔗 Links0
➡️ Path Items5
👷 Operations8
🔖 Tags3

The Markdown format is very useful for situations where a printable summary is useful. A good example is using it with regular update reports, or as a human-readable output from your CI system. The following example shows how to use the stats command in a GitHub action to make a nice GitHub summary:

name: Get API stats
on: push

    name: Stats as a job summary
    runs-on: ubuntu-latest
      - name: Check out repo's default branch
        uses: actions/checkout@v4
      - name: Set up node
        uses: actions/setup-node@v4
      - name: Install Redocly CLI
        run: npm install -g @redocly/cli@latest
      - name: Get stats
        run: redocly stats --format=markdown museum.yaml >> $GITHUB_STEP_SUMMARY 2>&1

This GitHub action uses the output of the stats command in Markdown format as the value for $GITHUB_STEP_SUMMARY. When the job is complete, it adds your API stats to the summary page, as shown in the following screenshot:

GitHub job summary showing API stats