Skip to content

Fix bun add command in documentation#8253

Closed
mrbuk wants to merge 1 commit intoQwikDev:mainfrom
mrbuk:patch-1
Closed

Fix bun add command in documentation#8253
mrbuk wants to merge 1 commit intoQwikDev:mainfrom
mrbuk:patch-1

Conversation

@mrbuk
Copy link
Copy Markdown

@mrbuk mrbuk commented Jan 19, 2026

Fix command to add the qwik dependency with bun. Current command bun run qwik add bun is not producing any sensible output:

% bun run qwik add bun
error: Script not found "qwik"

Instead using bun add qwik adds the dependency:

 % bun add qwik
bun add v1.3.6 (d530ed99)

installed qwik@1.0.57

1 package installed [296.00ms]

and creates a package.json

% cat package.json
{
  "dependencies": {
    "qwik": "^1.0.57"
  }
}%

As an enhancement - not implemented with this PR - one could consider using bun create qwik instead for the docs as this provides a way to create a full demo app that can be tested afterwards with bun start

What is it?

  • Docs / tests / types / typos

Description

Checklist

  • My code follows the developer guidelines of this project
  • I performed a self-review of my own code
  • I added a changeset with pnpm change
  • I made corresponding changes to the Qwik docs
  • I added new tests to cover the fix / functionality

Proper command to add the qwik dependency with bun
@mrbuk mrbuk requested a review from a team as a code owner January 19, 2026 23:10
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jan 19, 2026

⚠️ No Changeset found

Latest commit: 717873e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Copy Markdown
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

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

Thanks for your help @mrbuk
The idea here is to add the bun adapter on a working with app. So I think it's the correct command to use.

Copy link
Copy Markdown
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

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

@mrbuk thanks for opening this PR.
I'm closing this because it's working as intended.
We already have this phrase: "Qwik City Bun middleware allows you to hook up Qwik City to a Bun server which uses the Bun Http API." on that page that is self-explanatory.

@gioboa gioboa closed this Jan 29, 2026
@mrbuk
Copy link
Copy Markdown
Author

mrbuk commented Jan 29, 2026

@gioboa I think you have missed that there are two parts:

  1. there is an error in the current file. If you run the command as defined in index.mdx you will get an error because this is wrong. This is what was changed

  2. There was an "enhancement" question additionally, not directly related to the doc change. You seem to have closed this based on the fact that the you don't want the enhancement, which is fine but there is still an error addressed by the change that otherwise remains.

@gioboa gioboa reopened this Jan 29, 2026
@gioboa
Copy link
Copy Markdown
Member

gioboa commented Jan 29, 2026

Thanks for your response @mrbuk
bun run qwik add bun is adding the bun adapter to an already created project.

@mrbuk
Copy link
Copy Markdown
Author

mrbuk commented Jan 29, 2026

Thanks for clarifying @gioboa. I have misunderstood the docs then. I was not aware that they implied that qwik is already installed in that case.

@mrbuk mrbuk closed this Jan 29, 2026
@gioboa
Copy link
Copy Markdown
Member

gioboa commented Jan 29, 2026

No problem at all, that's fine ☺️thanks for your commitment and support @mrbuk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants