Introduction
Mongoose Studio is a developer-first GUI for Mongoose. It auto-detects your models and launches a modern dashboard to visualize your schema and manage your data—no configuration required.
Quickstart
Run Mongoose Studio instantly in your project root using npx:
npx mongoose-studio
or with bunx:
bunx mongoose-studio
Installation
If you prefer to install it globally (though npx is recommended):
npm install -g mongoose-studio
CLI Options
| Flag | Description | Default |
|---|---|---|
| --port | Specify the port to run on | 5555 |
| --uri | Custom MongoDB connection URI | mongodb://localhost... |
| --models | Path to models directory | Auto-detected |
Troubleshooting
⚠ Mongoose not found
Mongoose Studio couldn't find the mongoose package in your project.
Solution:
- Ensure you are running the command from your project root.
- Ensure you have installed dependencies (npm install).
⚠ Models directory not found
The path specified by --models or the default paths (models, src/models) do not exist.
Solution:
npx mongoose-studio --models=src/database/models
ℹ No Mongoose models registered
Mongoose connected, but no models were found. This usually means your model files aren't being required.
Solution:
Point explicitly to your models folder so Mongoose Studio can require them:
npx mongoose-studio --models=src/models