Skip to content

docs: update installation commands and instructions #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update installation commands and instructions #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91a9bbc
Update installCommands to include 'bunx' instead of 'bun'
DevdouglasGfs Mar 3, 2025
08eb109
Update installation instructions and launch commands in overview.mdx
DevdouglasGfs Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/mdx/Npx.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
const items = ["npm", "yarn", "pnpm", "bun"];
const html = await Astro.slots.render("default");
const installCommands = ["npx", "yarn", "pnpm", "bun"];
const installCommands = ["npx", "yarn", "pnpm", "bunx"];
const installLines = html
.replaceAll(/<\/?p>/g, "")
.replaceAll("—", "--")
Expand Down
29 changes: 5 additions & 24 deletions src/pages/drizzle-studio/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ delete and update everything based on your existing drizzle sql schema. It suppo
#### Install dependencies
Make sure to go through our [get started](/docs/get-started) guides first!

<Npx>
<Npm>
drizzle-orm
-D drizzle-kit
</Npx>
</Npm>

#### Prepare your database schema
Check out extended schema declaration **[docs.](/docs/sql-schema-declaration)**
Expand Down Expand Up @@ -53,28 +53,9 @@ export default defineConfig({
});
```
#### Launch Drizzle Studio
<Tabs items={["npm", "pnpm", "yarn", "bun"]}>
<Tab>
```bash copy
npx drizzle-kit studio
```
</Tab>
<Tab>
```bash copy
pnpm drizzle-kit studio
```
</Tab>
<Tab>
```bash copy
yarn drizzle-kit studio
```
</Tab>
<Tab>
```bash copy
bunx drizzle-kit studio
```
</Tab>
</Tabs>
<Npx>
drizzle-kit studio drizzle-orm
</Npx>

You can launch studio with `port` cli flag to customise process port and `verbose` flag for extended SQL statements logging
```bash
Expand Down