Home

Mongoterm Wiki

A lightweight Terminal User Interface (TUI) for managing and exploring MongoDB directly from the terminal — a Compass-style client, fully inside your shell.

Install & Run

npm i -g mongoterm@latest
mongoterm

Or from source:

git clone https://github.com/Fuse441/mongoterm.git
cd mongoterm
npm install
npm run dev

Pages

• Architecture — how the codebase and event-driven workflow are organized
• Keybindings — full keyboard reference
• Features — what's implemented today
• Roadmap — what's planned / missing vs. Compass

Current Features

• Manage multiple MongoDB connections
• Import / export connections (Compass JSON or mongosh URI list)
• Browse, create, and drop databases and collections
• View, insert, edit, delete, and duplicate documents
• Query with pagination, sort, and autocomplete
• Query shell modal (:) for composing larger filters
• Keybinding help popup (?)
• Cross-platform: macOS, Linux, Windows

Tech Stack

• Node.js + TypeScript
• neo-blessed (terminal UI)
• Official mongodb Node.js driver

For contributors and AI assistants

Before making any change to the codebase, read CLAUDE.md — it's the single source of truth for architecture, conventions, and known neo-blessed gotchas, kept in sync with the code as a hard rule in this repo. AGENTS.md, .cursorrules, and .github/copilot-instructions.md all point back to it so every AI tool converges on the same document.

Contributing

Contributions, suggestions, and feedback are welcome — open an issue or PR on the main repo. Please use Conventional Commits (feat:, fix:, docs:, ...); CHANGELOG.md is generated from them automatically.

License

MIT