1
0
mirror of https://github.com/garraflavatra/rolens.git synced 2024-11-21 22:18:59 +01:00
rolens/README.md

4.3 KiB

Rolens: intuitive MongoDB administration tool

Robust, blazing-fast, comprehensive, yet simple MongoDB administration tool for Windows, macOS and Linux.

CI Documentation

Why another MongoDB client?

This project arose from all flaws of similar tools many of which are slow, complicated, heavy, and fairly unwieldy. They mostly require quite a high level of knowledge on how to operate the program.

Rolens aims to be the intuitive, lightweight counterpart of these overengineered tools.

  • Lightweight: Rolens weighs about 15 MB.
  • Open source: You know what's inside!
  • Low overhead: Typical query results against a local database are returned whithin milliseconds.
  • Intuitive interface: You know MongoDB? You know Rolens.

Impression of Rolens's interface

This project is heavily inspired by the excellent MongoHub application, which sadly has not been updated since 2011.

Download and installation

Rolens can run on the following operating systems:

  • Windows 10/11 amd64/arm64
  • Linux amd64/arm64
  • macOS 10.13+ amd64 (Intel)
  • macOS 11.0+ arm64 (Apple Silicon)

Pre-compiled binaries

You can obtain a pre-compiled Rolens binary for macOS or installer for Windows from the release page.

Compiling from source

If you have Node.js installed, just download the source from GitHub, and run node ./build.js. The install script will check that dependencies are present and build Rolens for you.

If you want to build it yourself, please refer to the advanced build process documentation for detailed compilation instructions.

User guide

Rolens is designed to be as intuitive as possible. But if something is unclear nevertheless, you can consult the user manual to learn how to use the program.

Questions and bugs

Feel free to contact me if you have questions! Send an e-mail.

Feature list

At this point, Rolens is comparable to MongoHub regarding features. It cannot handle things like user management yet, but it does have:

  • Connecting to hosts
    • Host status
    • System info
  • Database management
    • See stats
    • Create dumps with mongodump
  • Collections
    • See stats
    • Find, insert, update, & remove
    • Save queries to reuse them
    • Customizable table view for query results
    • Versatile forms to enter data in a standardized format
    • Aggregation pipeline editor
    • Fully customizable export to a number of formats like JSON, CSV, and Excel
    • Index editor

Wishlist

Author and license

© Romein van Buren 2023. The source code and compiled binaries are released under the GNU GPLv3 license — see LICENSE for the full license text.

Credits