61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
<div align="center">
|
|
<img src="./assets/logo/no-background.svg" width="600">
|
|
</div>
|
|
|
|
---
|
|
|
|
## 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.
|
|
|
|
Visit [vi-mongo.com](https://vi-mongo.com) for more information.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
To install Vi Mongo, follow the instructions on the [installation page](https://vi-mongo.com/docs/installation).
|
|
|
|
If you are using [Neovim](https://neovim.io/) you can install the plugin from [nvim-plugin](https://github.com/kopecmaciej/vi-mongo.nvim)
|
|
|
|
## Features
|
|
|
|
- **Intuitive Navigation**: Vi Mongo's simple, intuitive interface makes it easy
|
|
to navigate and manage your MongoDB databases.
|
|
- **Fast switching between databases**: Vi Mongo allows you to fast switch
|
|
between 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.
|
|
- **Multiple Styles**: Vi Mongo supports multiple color schemes, they can be
|
|
selected in config file or add/modify easily.
|
|
|
|
## List of features to be implemented
|
|
|
|
[vi-mongo.com/docs/roadmap](https://vi-mongo.com/docs/roadmap)
|
|
|
|
## Contributing
|
|
|
|
All contributions are welcome!
|
|
|
|
1. Create an issue
|
|
2. Fork the repository
|
|
3. Go with the flow
|
|
|
|
If possible please write tests for your changes.
|
|
|
|
## Issues
|
|
|
|
For now all issues are resolved, but if you find any new issues, please report
|
|
them in the [GitHub Issues](https://github.com/kopecmaciej/vi-mongo/issues)
|
|
page.
|