Mongoose Studio

The Modern, Zero-Config GUI for Your Mongoose Models.

Inspect schemas, visualize data, and debug queries instantly without leaving your terminal.

## What's New in v1.2 Mongoose Studio just got a major upgrade. We've refined every pixel to give you a premium developer experience. - **Premium UI Overhaul**: A completely redesigned, high-contrast dark mode interface. - **Smart Type Inference**: Automatically detects `Boolean`, `Date`, and `ObjectID` fields from your data. - **Deep Linking**: Navigate relationships (e.g., `author_id`) with a single click in a side panel. - **Visual Aggregation Builder**: Orchestrate complex pipelines visually. - **Tabs Workspace**: Keep multiple models and documents open simultaneously. --- ## Features - **Schema-Aware**: Visualizes data respecting your Mongoose schema types. - **Smart Grid**: Virtualized high-performance data grid capable of handling thousands of rows. - **CRUD Operations**: Create, Edit (with JSON/Form views), and Delete documents directly. - **Deep Linking**: Seamlessly navigate between related documents. - **Data Seeding**: Instantly generate fake data for testing (powered by **faker.js**). - **Read-Only Mode**: Use `--readonly` for safer production inspection. - **Instant Launch**: Runs directly from your terminal using `npx`. --- ## Quick Start No config needed. Just go to your project directory and run: ```bash npx mongoose-studio ``` ### Seeding Data Need dummy data? Click the **Seed Data** button in the toolbar to generate 10 random documents based on your schema. ### Read-Only Mode To prevent accidental edits (e.g., in production), run with the `--readonly` flag: ```bash npx mongoose-studio --readonly ``` --- ## Configuration | Flag | Default | Description | | :----------- | :--------------------------- | :----------------------------------------------------------- | | `--port` | `5555` | The port to run the Studio server on. | | `--uri` | `process.env.MONGO_URI` | Custom MongoDB connection string. | | `--models` | Auto-detected | Path to your models folder if not found automatically. | | `--readonly` | `false` | Disable all write operations (Create, Update, Delete, Seed). | **Example:** ```bash npx mongoose-studio --port=8080 --readonly ``` --- ## Troubleshooting

"Mongoose not found"

Ensure you are running the command in the root of a project that has `mongoose` installed.

"No models found"

Mongoose Studio looks in common folders (`models`, `src/models`, `lib/models`). If you store them elsewhere, use the `--models` flag: `npx mongoose-studio --models=src/entities`

"Port in use"

If port 5555 is taken, the tool connects to the next available port automatically (e.g., 5556).

> For deeper troubleshooting, check the [Documentation Site](https://mongoose-studio.yaasir.dev/docs). --- ## Contributing We love contributions! Mongoose Studio is a monorepo built with **Bun**, **Hono** (Server), and **Next.js** (UI). 1. Clone the repository. 2. Run `bun install`. 3. Run `bun run dev` to start both the CLI logic and the Next.js UI in development mode. --- ## License MIT © [Yasir](https://github.com/sirrryasir)