Skip to content

feat: studio made optional - #2283

Open
neoandmatrix wants to merge 6 commits into
asyncapi:masterfrom
neoandmatrix:size-optimization
Open

feat: studio made optional#2283
neoandmatrix wants to merge 6 commits into
asyncapi:masterfrom
neoandmatrix:size-optimization

Conversation

@neoandmatrix

@neoandmatrix neoandmatrix commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

This PR makes studio an optional package for cli to reduce its size by 500 MB. New flags are added to enable studio be installed optionally.

Studio availability & behavior by environment

Environment Studio present out-of-the-box? start studio / preview / new --studio PDF (html-template) Core cmds (validate, convert, generate, bundle, diff, optimize, new)
CLI — npm i -g @asyncapi/cli (dev machine) No (devDeps not installed for consumers) Interactive TTY → prompt "~450MB, proceed?" → installs to data dir → launches. Later runs: no prompt. Works (via html-template's own puppeteer) Work
Docker — asyncapi/cli image No (--omit=dev excludes it) No TTY → auto-declines with clear error unless --yes / -e ASYNCAPI_STUDIO_AUTO_INSTALL=1. With those → installs into container. Works out of the box (chromium kept in image) Work
CI — your CLI in a user pipeline (non-interactive) No No TTY → auto-declines unless --yes / ASYNCAPI_STUDIO_AUTO_INSTALL=1 → installs (needs network) Works Work
CI — this repo's own test suite (npm ci) Yes (devDeps installed) Resolves the installed devDep → no prompt; studio integration test runs Works Work
GitHub Action image (asyncapi/github-action-for-cli) No (--production) Not used in actions; if invoked, no TTY → clear error Unchanged from before (action image never bundled chromium) Work

Docker build and image size has also been reduced to 643 MB from previous 1.6 GB.
image

Signed-off-by: Tushar Anand <tusharannand@gmail.com>
@changeset-bot

changeset-bot Bot commented Aug 19, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 865693e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@asyncapi/cli Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@neoandmatrix
neoandmatrix marked this pull request as draft August 19, 2026 15:27
Signed-off-by: Tushar Anand <tusharannand@gmail.com>
@neoandmatrix
neoandmatrix marked this pull request as ready for review August 19, 2026 16:23
@neoandmatrix
neoandmatrix marked this pull request as draft August 19, 2026 16:30
Signed-off-by: Tushar Anand <tusharannand@gmail.com>
@neoandmatrix neoandmatrix changed the title chore:studio made optional studio made optional Aug 20, 2026
@neoandmatrix
neoandmatrix marked this pull request as ready for review August 20, 2026 14:24
@neoandmatrix
neoandmatrix marked this pull request as draft August 20, 2026 14:46
Signed-off-by: Tushar Anand <tusharannand@gmail.com>
@neoandmatrix
neoandmatrix marked this pull request as ready for review August 21, 2026 19:00
@neoandmatrix
neoandmatrix marked this pull request as draft August 21, 2026 19:12
neoandmatrix and others added 2 commits August 22, 2026 11:17
Signed-off-by: Tushar Anand <tusharannand@gmail.com>
@sonarqubecloud

Copy link
Copy Markdown

@neoandmatrix
neoandmatrix marked this pull request as ready for review August 22, 2026 06:07
@neoandmatrix neoandmatrix changed the title studio made optional feat: studio made optional Aug 22, 2026

@Shurtu-gal Shurtu-gal left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we add a flag to the config so that studio is always installed, if the user wants in case?

@github-project-automation github-project-automation Bot moved this from To Triage to Backlog in CLI - Kanban Aug 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

2 participants