Repository navigation
v2.0.0-beta.1
Pre-release
Pre-release
·
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 insrc/spec/, Markdown pages insrc/content/, and images and other files insrc/static/. (#343) src/apimatic.jsonreplacesplugin-config.json. Itslanguagesblock lists the project's SDK languages, and itspluginblock holds the plugin's identity.plugin-config.jsonis no longer read, so runplugin generateandsdk publishagain after upgrading, then delete it. (#348)- Some portal commands are removed.
portal toc new,portal recipe newandportal copilotare gone, andportal serveno longer takes--destinationor--no-reload. Runapimatic autocomplete --refresh-cacheto drop them from shell completion. - SDKs are generated with v4 only. (#359)
--codegen-versiononsdk generateandsdk publishaccepts onlyv4, 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-changesis removed, along with--track-changesand--skip-changesonsdk generate.sdk publishno longer takes--update-plugin-config. Every publish records itself insrc/apimatic.json.
apimatic quickstartalways builds a portal. It no longer offers an SDK instead. Useapimatic sdk generatefor 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)