romein/rolens
1
0
Fork 0
mirror of https://github.com/garraflavatra/rolens.git synced 2025-06-28 05:25:11 +00:00
Code Issues Releases Activity

Added shell documentation

Browse Source
This commit is contained in:
Romein van Buren
2023-07-19 20:45:05 +02:00
parent 77747c10c2
commit 43fce1f27e
4 changed files with 41 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/shell.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 602 KiB

15
docs/user-guide/shell.md Normal file
View File

@ -0,0 +1,15 @@
---
title: Shell
summary: "Write and execute MongoDB shell scripts within Rolens"
parent: User guide
order: 60
stub: true
---
Rolens has a shell feature: it provides an editor for writing shell scripts and executing them against a local or external host, database, or even a single collection. You can find it under the _Shell_ tab.
![The shell tab](/images/shell.png)
## Requirements
To use the script editor, you need to install the official [`mongosh` tool](https://www.mongodb.com/docs/mongodb-shell/) from MongoDB. You can [download it](https://www.mongodb.com/try/download/shell) from the MongoDB web site, or run `brew install mongosh` if you use a Mac.