8000 GitHub - linkref/elosql: Personal MongoDB Compass fork with collection scripts and a monochrome interface. · GitHub
[go: up one dir, main page]

Skip to content
linkrefPublic
forked from mongodb-js/compass

About

Personal MongoDB Compass fork with collection scripts and a monochrome interface.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

20,715 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

elosql

Public repository

Personal desktop fork of MongoDB Compass. The MongoDB Git history, workspace package names, and original distributions are preserved to simplify upstream merges. elosql has its own application identity and icon.

Develop elosql

npm run dev:elosql

The launcher uses the local Node runtime in .elosql/node when available, then starts the original Compass development server with the elosql distribution. On a fresh checkout, install the Node/npm versions required by package.json and run npm run bootstrap first. .elosql contains local tools only and is not committed. Webpack rebuilds changed modules; some UI changes hot-reload, while others require refreshing the window or restarting the app.

Interface color

Change brandColor in packages/compass-components/src/theme/brand-color.ts to set the shared UI accent (currently #000000). Hover colors and light/dark shades are derived from that value. The desktop interface is monochrome: the document root and top-layer menus/dialogs use grayscale(1) in packages/compass/src/app/styles/index.less. This also removes residual colors from LeafyGreen, illustrations, status indicators, charts, and the editor without depending on private component markup. Remove that filter to restore colors when choosing a different accent. Refresh or restart the development app after changing the appearance.

Collection scripts

Collection document tabs open in Script mode. Run mongosh code above the existing Compass results toolbar, pagination, and list/JSON/table views. The Filters switch returns to the original query builder. print(), printjson(), scalar results, and errors appear in the complementary console.

Run executes the selected text, or the whole script when nothing is selected (Cmd/Ctrl+Enter). Run all always executes the whole script (Cmd/Ctrl+Shift+Enter); Stop terminates the current execution. Each run starts a fresh session on the collection's database. Script text is only kept while the tab is open; no script history is saved.

Cursor pagination continues the executed query without running the script again. Refresh replays only a supported read query, never preceding script statements. Bulk actions use the executed find filter; transformed or cross-collection results are read-only. Results are capped at 10,000 documents / 32 MiB and console output at 1,000,000 characters, with a visible limit notice. Export Data uses the full supported query, or the captured documents when no replayable query exists.

Bring in MongoDB changes

The upstream remote points to https://github.com/mongodb-js/compass.git. Work on the elosql branch, commit local changes, then merge upstream history:

git fetch upstream
git switch elosql
git merge upstream/main
export PATH="$PWD/.elosql/node/bin:$PATH" # Use the local runtime when present.
npm run bootstrap
npm run dev:elosql

Resolve any merge conflicts while preserving elosql's branding, then validate the app. Match the Node/npm versions in the updated package.json before bootstrapping. Pushing to upstream is disabled in this local clone. The origin remote points to the public fork at https://github.com/linkref/elosql.git. Publish local changes with git push origin elosql.

Upstream documentation

The original MongoDB Compass documentation follows below.

MongoDB Compass Monorepo

This repository contains the source code and build tooling used in MongoDB Compass.

Aggregation Pipeline Builder Tab in Compass

Contributing

For contributing, please refer to CONTRIBUTING.md

For issues, please create a ticket in our JIRA Project.

Is there anything else you’d like to see in Compass? Let us know by submitting suggestions in out feedback forum.

Packages Overview

Compass Plugins

Shared Libraries and Build Tools

Shared Configuration Files

License

SSPL

About

Personal MongoDB Compass fork with collection scripts and a monochrome interface.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0