Console command

Explore OpenAPI changes in your terminal.

The console command opens the interactive terminal UI for browsing changes across revisions.

Examples:

openapi-changes console ./ sample-specs/petstorev3.json openapi-changes console HEAD~1:openapi.yaml ./openapi.yaml

You should see something like this:

Keyboard controls

At any point, press Ctrl-C or q to quit. Escape steps back through the current view and returns focus to the previous panel or closes the current overlay.

The console has three main panels:

  • commit history
  • semantic change tree
  • diff view

The usual flow is:

  1. Move through commits with Up / Down
  2. Press Enter to move into the change tree
  3. Move through changes with Up / Down
  4. Press Enter to open the code view for the selected change

Additional controls:

  • Tab: switch between commit history, tree, and diff panels
  • r: open the rendered markdown report overlay for the active revision
  • PgUp / PgDn: page through the tree, diff, or overlay
  • Home / End: jump to the start or end of the current tree or scrollable view
  • Space: recenter the highlighted change in the code view
  • Escape, Enter, or q: close the code or report overlay

Theme flags

The console supports the shared terminal theme flags:

openapi-changes console --roger-mode ./ sample-specs/petstorev3.json openapi-changes console --tektronix ./ sample-specs/petstorev3.json

See Command Arguments for the shared flags.