Skip to content

v2.0.0-beta.1

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 28 Sep 15:08
· 44 commits to beta since this release

2.0.0-beta.1 (2026-09-28)

Note

This is a beta of the APIMatic CLI 2.0. Install it with npm install -g @apimatic/cli@beta. Running npm install -g @apimatic/cli without @beta still installs 1.5.0.

In 2.0 the CLI builds documentation portals on your machine, configures a project from a single src/apimatic.json, adds SDK and Context Plugin pages and code samples to a portal, and generates SDKs with the v4 generator.

Breaking changes

Read Upgrading from 1.x before moving a 1.x project over. Since 2.0.0-beta.5, apimatic quickstart refuses a project whose src/spec/ holds files but that has no src/apimatic.json. To scaffold that file, run apimatic quickstart in an empty directory and copy the src/apimatic.json it writes into your project.

  • Node.js 24 or newer is required. On an older Node the CLI stops at startup and names the version it found. (#347)
  • Portals are built locally from src/. OpenAPI documents go in src/spec/, Markdown pages in src/content/, and images and other files in src/static/. (#343)
    • The portal block of src/apimatic.json configures the portal. APIMATIC-BUILD.json no longer does. (#348)
    • Every page needs front matter with a title. The CLI lists the pages that lack one before it builds.
    • Page order and tabs come from nav.json. toc.yml is no longer read. (#346, #371)
  • src/apimatic.json replaces plugin-config.json. Its languages block lists the project's SDK languages, and its plugin block holds the plugin's identity. plugin-config.json is no longer read, so run plugin generate and sdk publish again after upgrading, then delete it. (#348)
  • Some portal commands are removed. portal toc new, portal recipe new and portal copilot are gone, and portal serve no longer takes --destination or --no-reload. Run apimatic autocomplete --refresh-cache to drop them from shell completion.
  • SDKs are generated with v4 only. (#359)
    • --codegen-version on sdk generate and sdk publish accepts only v4, which is now the default.
    • C#, Python and TypeScript can be generated today. Java, Ruby, PHP and Go come back as v4 supports them.
    • apimatic sdk save-changes is removed, along with --track-changes and --skip-changes on sdk generate.
    • sdk publish no longer takes --update-plugin-config. Every publish records itself in src/apimatic.json.
  • apimatic quickstart always builds a portal. It no longer offers an SDK instead. Use apimatic sdk generate for an SDK on its own. (#363)

Features

  • code samples support (#352) (7b82568)
  • config: replace portal.json and plugin-config.json with apimatic.json (#348) (506f67f)
  • local plugin generation (#358) (5ba70de)
  • portal: build the documentation portal locally with Fumadocs (#343) (073d09a)
  • portal: build the SDK and Context Plugin pages from real templates and the portal artifacts (#369) (0efd7b3)
  • portal: fetch the artifacts from /portal-artifacts (#361) (0e823f3)
  • portal: generate the SDK and context plugin pages (#360) (338b14a)
  • portal: give the portal block its v2 shape, with branding and tabs (#355) (d0fb189)
  • portal: lead each SDK card with its install command (#376) (119e9d6)
  • portal: let the root nav.json decide the tabs, and fix the nav.json QA findings (#371) (ecf7666)
  • portal: order the sidebar from nav.json (#346) (306e4f9)
  • portal: point to api transform when src/spec has no OpenAPI 3.x document (#364) (eefc917)
  • portal: the SDK Overview design, on the SDKs, language and plugin pages (#391) (fd3fe34)
  • quickstart: suggest validating with an AI agent when a spec fails (#385) (36fd2bb)

Fixes since 1.5.0

  • Validation errors the server reports during plugin generate print as plain text rather than raw HTML. (#375)
  • The interactive sdk publish asks "Do you want to proceed?" with No selected, so pressing Enter no longer starts a publish. (#375)