mongotui

command module
v1.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2025 License: MIT Imports: 2 Imported by: 0

README ยถ

Mongotui

Mongotui is a terminal user interface MongoDB client that is designed to be easy to use and fast.

demo.gif

Usage

Mongotui aims to make switching from mongosh easy as it aims to have a similar flags and commands when first connecting to the MongoDB server.

If you have a local MongoDB server running on the default port and no authentication, you can run the following command to get up and running.

mongotui localhost

Mongotui also accepts full MongoDB connection strings.

mongotui mongodb://user:password@localhost:27017

Explore the help menu if additional connection information is required.

mongotui --help

Features

  • ๐Ÿ”— Similar connection flags/options to mongosh
  • ๐Ÿ“‚ Navigate between databases/collections/documents
  • ๐Ÿ” Query for specific documents
  • ๐Ÿ“„ Pagination of results
  • ๐Ÿ‘๏ธ View an entire document
  • โœ๏ธ Edit a document using your $EDITOR of choice
  • ๐Ÿ—‘๏ธ Delete a database/collection/document

Installation

MacOS

If you have HomeBrew installed, use the tap shown below.

brew tap kreulenk/brew
brew install mongotui
Linux

Navigate to the Releases section of mongotui's GitHub repository and download the latest tar for your processor architecture. Then, untar the executable and move it to /usr/local/bin/mongotui.

E.g.

curl -OL https://github.com/kreulenk/mongotui/releases/download/v1.1.1/mongotui-linux-amd64.tar.gz
tar -xzvf mongotui-linux-amd64.tar.gz
mv ./mongotui /usr/local/bin/mongotui
Build From Source

Ensure that you have at least Go 1.23 installed on your system.

Then, run

make install

Documentation ยถ

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL