vi-mongo

command module
v0.1.2-beta Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

README

Showcasing some of the features of Vi Mongo

Managing connections (adding, removing)

Working with documents (viewing, duplicating, deleting), autocomplete, etc.

Overview

Vi Mongo is an intuitive Terminal User Interface (TUI) application, written in Go, designed to streamline and simplify the management of MongoDB databases. Emphasizing ease of use without sacrificing functionality, Vi Mongo offers a user-friendly command-line experience for database administrators and developers alike.

Features

  • Intuitive Navigation: Vi Mongo's simple, intuitive interface makes it easy to navigate and manage your MongoDB databases.
  • Managing Documents: Vi Mongo allows you to view, create, update, duplicate and delete documents in your databases with ease.
  • Managing Collections: Vi Mongo provides a simple way to manage your collections, including the ability to create, delete collections.
  • Autocomplete: Vi Mongo offers an autocomplete feature that suggests collection names, database names, and MongoDB commands as you type.
  • Query History: Vi Mongo keeps track of your query history, allowing you to easily access and reuse previous queries.

Installation

Using curl

curl https://api.github.com/repos/kopecmaciej/vimongo/releases/latest | jq -r '.assets[0].browser_download_url' | xargs curl -L -o vimongo
# or if no jq installed
# curl https://api.github.com/repos/kopecmaciej/vimongo/releases/latest | grep browser_download_url | cut -d '"' -f4 | xargs curl -L -o vimongo
chmod +x vimongo
sudo mv vimongo /usr/bin

Using wget

wget -O - https://api.github.com/repos/kopecmaciej/vimongo/releases/latest | jq -r '.assets[0].browser_download_url' | xargs wget
chmod +x vimongo
sudo mv vimongo /usr/bin

Using Go

git clone git@github.com:kopecmaciej/vimongo.git
cd vimongo
make

Usage

After installing Vi Mongo, you can run it by typing vimongo in your terminal.

vimongo

In any moment you can press Ctrl + H to see help page with all available shortcuts. Resizing terminal while running Vi Mongo should work fine, but if you encounter any issues, please let me know.

All configuration files should be stored in ~/.config/vimongo directory, but it depends on the system settings as env XDG_CONFIG_HOME can be set to different directories (more information here: XDG Base Directory)

List of features to be implemented

  • Query History
  • Switching between multiple Connections
  • Help page
  • Improve Content by adding other possibilities of viewing
  • Move autocomplete keys to json file, so that it can be easily modified
  • Hash passwords in config
  • Multiple styles
  • Managing Indexes
  • Aggregation Pipeline
  • Exporting/Importing Documents

Issues

  • Searching collection on databases not expanding tree
  • No clearing history
  • No view with shortcuts
  • Header not updated after changing database/collection
  • Content not updated after editing from picker
  • Performance issue while loading large bson files

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
tui

Jump to

Keyboard shortcuts

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