The MongoDB GUI.
Running Compass locally requires Node.js and npm:
Node.js: ^16.15.0npm: ^8.15.1
npm install
npm start [compass|compass-readonly|compass-isolated]Current Plugin API Version: 3.0.0
Majority of Compass' functionality lives in various plugins outside the main repo. This repo just brings them all together. All external plugins are tagged via the compass-plugin topic in the mongodb-js organisation. There are also various compass-tools and compass-ui-tools packages that help put together the application.
Plugins can be added to Compass by requiring them as a dependency in package.json,
and by adding their installed location to the distribution plugin list also in the
package.json. Plugin's apiVersion field has to match Compass'. Currently it's
at 3.0.0.
Example of adding a dependency:
npm i -S @mongodb-js/compass-aggregations@latestAnd in package.json:
"distributions": {
"default": "compass",
"compass": {
"name": "mongodb-compass",
"plugins": [
"node_modules/@mongodb-js/compass-aggregations", // add compass-aggregations
// rest of the plugins required for this distribution
],
"styles": [
"index"
]
},
// other distribution config
}For issues, please create a ticket in our JIRA Project.
For contributing, please refer to CONTRIBUTING.md
Is there anything else you’d like to see in Compass? Let us know by submitting suggestions in out feedback forum.