db-studio - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #llm #golang #android #rust #linux #nodejs #awesome #cli #vue #pytorch #ios #openai

db-studio

(★ 258)

The modern pgAdmin alternative that works with every database.

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.yml
  - config.yml
  - feature_request.yml
- - auto-pr.yml
  - bundle-size.yml
  - check.yml
  - deploy-www.yml
  - release.yml
- dependabot.yml
- FUNDING.yml
- pre-commit
- icon.png
- logo-light.png
- panner.png
- screenshot.png
- FRONTEND_ARCHITECTURE_PLAN.md
- SERVER_REVAMP_PLAN.md
- - .gitignore
  - package.json
  - README.md
  - tsconfig.json
  - worker-configuration.d.ts
  - wrangler.toml
- - .gitignore
  - .npmignore
  - package.json
  - README.md
  - tsconfig.json
  - tsup.config.ts
  - vitest.config.ts
  - wrangler.jsonc
- - .gitignore
  - package.json
  - README.md
  - tsconfig.json
- - package.json
  - tsconfig.json
- - .gitignore
  - components.json
  - eslint.config.js
  - index.html
  - package.json
  - README.md
  - tsconfig.app.json
  - tsconfig.json
  - tsconfig.node.json
  - vite.config.ts
  - vitest.config.ts
- generate-release-notes.js
- init-db-mongo.sh
- init-db-mssql.sh
- init-db-mysql.sh
- init-db-pgsql.sh
- init-db-redis.sh
- init-db-sqlite.sh
- - browser.ts
  - dynamic.ts
  - server.ts
- - avocado.png
  - favicon.ico
  - joined-wishlist.html
  - llms.txt
  - logo.png
  - manifest.json
  - og-image.png
  - robots.txt
  - sitemap.xml
  - studio.png
- - router.tsx
  - routeTree.gen.ts
  - styles.css
- .cta.json
- .gitignore
- cli.json
- components.json
- package.json
- README.md
- source.config.ts
- tsconfig.json
- vite.config.ts
- worker-configuration.d.ts
- wrangler.toml
.coderabbit.yaml
.gitignore
AGENTS.md
AUTHORS
biome.json
bun.lock
bunfig.toml
CLAUDE.md
CODEOWNERS
CONTEXT.md
CONTRIBUTING.md
knip.json
LICENSE
package.json
PATTERNS.md
README.md
turbo.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="assets/logo-light.png">
  <source media="(prefers-color-scheme: light)" srcset="assets/logo-dark.png">
  <img src="assets/logo-light.png" alt="DB Studio logo" width="100">
</picture>

<br>

<div align="center">
A modern, universal (pgAdmin alternative) database management studio for any database.
</div>

<br>

<div align="center">
  <a href="https://github.com/husamql3/db-studio/stargazers">
    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/husamql3/db-studio">
  </a>
  <a href="https://www.npmjs.com/package/db-studio">
    <img src="https://img.shields.io/npm/v/db-studio?style=flat-rounded" />
  </a>
  <a href="https://www.npmjs.com/package/db-studio">
    <img src="https://img.shields.io/npm/dm/db-studio?style=flat-rounded" />
  </a>
  <a href="https://github.com/husamql3/db-studio/blob/main/LICENSE">
    <img alt="License" src="https://img.shields.io/github/license/husamql3/db-studio">
  </a>
  <a href="https://deepwiki.com/husamql3/db-studio">
    <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
  </a>
</div>

<br>

<img src="assets/screenshot.png" alt="DB Studio screenshot" width="1000" />
</div>

## Tech Stack

- **Frontend**: React 19, TanStack React Router, TanStack React Query, TanStack React Table, TanStack React Virtual, shadcn/ui, sonner, react-day-picker, react-hook-form, zustand
- **Backend**: Hono with Node, zod-validator, zod
- **Tooling**: Bun, Vite, TypeScript, Biome, Vitest, Wrangler (Cloudflare)

## Quick Start with npx

No installation required. Just run:

```bash
npx db-studio
```

This runs the latest published version and uses the **current directory** as the project context. DB Studio looks for a `.env` file in the current working directory and, if not found, searches parent directories until one is found. It reads `DATABASE_URL` from that file (or use `--var-name <name>` for a different variable). If `DATABASE_URL` is not in the .env file, it is also read from **process.env** (e.g. when set in the shell or in a package.json script). To point to a specific env file, use `--env <path>` (e.g. `npx db-studio --env .env.local`).

### Recommended base script (add to package.json)

You can run db-studio from npm/bun scripts. Useful when you want a dedicated script, a different env file, or to pass the connection via the environment:

```json
{
  "scripts": {
    "db:studio": "npx db-studio"
  }
}
```

Now you can simply run:

```Bash
npm run db:studio
```

### Customize with flags

Modify the run command (or override in your script) using any of these flags:

| Flag                        | Description                                      | Example command / override                                                  |
|-----------------------------|--------------------------------------------------|-----------------------------------------------------------------------------|
| `--env <path>`              | Use a specific `.env` file                       | `npx db-studio --env .env.local` <br>or `--env .env.production`             |
| `--var-name <name>`         | Use a different environment variable name        | `npx db-studio --var-name MY_DB_URL`                                        |
| `--port <number>`           | Change the server port (default: 3333)           | `npx db-studio --port 4000`                                                 |
| `--database-url <url>`      | Provide connection string directly (no `.env`)   | `npx db-studio --database-url "postgresql://user:pass@localhost:5432/mydb"` |
| `--status`                  | Only check & show connection status (no UI)      | `npx db-studio --status`                                                    |
| `--help`                    | Show all available options                       | `npx db-studio --help`                                                      |

#### Examples of combined / overridden usage

```bash

# Local dev with custom env file
npm run db:studio -- --env .env.local

# Production with custom port
bun run db:studio -- --env .env.production --port 4444

# Direct connection (great for one-off or CI)
npx db-studio --database-url "postgresql://user:pass@host:5432/prod"

# Custom variable name + env file
npm run db:studio -- --env .env.staging --var-name STAGING_DB_URL

# Just verify connection
npm run db:studio -- --status
```

> **Tip**: When passing flags through `npm run` or `bun run`, use `--` to separate script args from command flags (as shown above).

For full documentation and more examples: [dbstudio.sh](https://dbstudio.sh)

## Development Setup

**Using the CLI (installed or npx):** Run `npx db-studio` from a directory that contains your `.env` (or from a subfolder; DB Studio will search upward for `.env`). Alternatively use `--env <path>` to specify the env file.

**Developing from source:**

```bash
# Install dependencies (root and workspaces)
bun install

# Initialize the database with required tables and schema
bun run init-db

# Configure your PostgreSQL connection in packages/server/.env (for local dev)
# DATABASE_URL=postgres://user:password@localhost:5432/database

# Start development services through Portless
bun run dev
```

At your first contribution, you should add your name and email to the `AUTHORS` file

```bash
your-name <your-email>
```

Development services run through [Portless](https://portless.sh/) with stable local HTTPS URLs instead of fixed port numbers:

| Service | URL |
|---------|-----|
| Web app | `https://web.dbstudio.localhost` |
| API server | `https://api.dbstudio.localhost` |
| AI proxy | `https://proxy.dbstudio.localhost` |
| Docs/marketing site | `https://www.dbstudio.localhost` |

On first run, Portless may ask to trust its local certificate authority. You can also run:

```bash
bunx portless trust
```

> [!NOTE]
> Production-style local serving runs through `https://db-studio.localhost` via the server package `start` script.

## Roadmap

For the latest features, planned updates, and development progress, see the full roadmap here:

[📍 roadmap](https://dbstudio.sh/roadmap)

Contributions that align with roadmap priorities are especially welcome!

## Changelog

See what's new, fixed, or improved in each release:

[📜 Changelog](https://dbstudio.sh/changelog)

# Contributing

Extremely welcome! This is early-stage — PRs for new drivers, bug fixes, or even a better logo will be merged lightning-fast.
Check out [CONTRIBUTING.md](/CONTRIBUTING.md) and the open issues.

## License

Apache License 2.0 — see [LICENSE](/LICENSE)