Documentation

Getting Started with VisuaLeaf

Welcome

The Welcome Screen is your gateway to VisualLeaf MongoDB GUI. It provides instant access to connections, displays your license status, and offers quick actions to start working with your MongoDB databases immediately.

Quick Start

Get started with VisualLeaf in three simple steps:

  1. Activate your license by clicking "Login" or "Register" in the header
  2. Click "View Connections" to open the connections sidebar and select a database
  3. Start exploring your data with VisualLeaf's powerful tools
Welcome screen showing the header with license status, quick start actions, recent connections panel, and key features grid
Video WELC02 Getting Started with VisualLeaf - Complete walkthrough of the Welcome Screen and first connection setup

Screen Layout

The Welcome Screen is organized into several key areas that provide different information and actions:

1. Header Section

The top section displays the VisualLeaf branding and your current license status.

Header section showing the VisualLeaf logo and license status card
  • VisualLeaf Logo - Displays the application branding with the tagline "Visualize. Query. Discover."
  • License Status Card - Shows your current license information (when logged in)
  • Login/Register Buttons - Appears when no license is active, allowing you to authenticate

2. Quick Start Section

Located on the left side, this section provides quick access to the most common actions.

Quick Start panel showing the action buttons (View Connections, Connection Manager, MongoDB Atlas, Register License)
  • View Connections - Opens the connections sidebar to browse and connect to databases
  • Connection Manager - Opens the full connection management interface for creating and organizing connections
  • MongoDB Atlas - External link to create a free MongoDB cloud database
  • Register License - Opens the license registration page (only shown when not logged in)

3. Recent Connections Panel

Below the Quick Start section, you'll find your three most recently connected databases.

Recent Connections panel showing connection cards with status, host/port, project info, and connect/disconnect buttons

4. Help & Resources Bar

At the bottom, a compact help bar provides quick access to documentation and support resources.

License Status Display

The license status card in the header provides real-time information about your VisualLeaf license. The display changes based on your current authentication state.

License status card showing active license with green indicator, email, plan type, and expiration date

When Licensed (Active)

If you have an active license, the card displays:

  • Status Indicator - Green pulsing dot showing "License Active"
  • Email Address - The email associated with your license
  • Plan Type - Your current plan (Free, Pro, Enterprise, etc.)
  • Expiration Date - When your license expires (for paid plans)
  • Trial Badge - If on a trial, displays remaining days with color coding:
    • Blue badge: More than 7 days remaining
    • Orange badge: 4-7 days remaining
    • Red badge: 3 or fewer days remaining
License status card for unlicensed user showing License Required message with Login and Register buttons

When Not Licensed

If you don't have an active license, the card displays:

  • "License Required" Message - Prompts you to login or register
  • Login Button - Opens authentication flow to activate your license
  • Register Button - Opens the license registration page in your browser

Note: Most VisualLeaf features require an active license. The Quick Start actions will be disabled until you authenticate.

Recent Connections

The Recent Connections panel shows your three most recently used database connections, sorted by last connection time. This provides quick access to your frequently used databases.

Recent connection card showing connection name, connected status, host:port, project/environment tags, and last connected timestamp

Connection Card Information

Each connection card displays:

  • Connection Name - The name you assigned to the connection
  • Connection Status - Green "Connected" indicator or gray "Disconnected" indicator with icon
  • Host and Port - The database server address and port number
  • Project Context - If the connection belongs to a project, shows:
    • Project name (with folder icon)
    • Environment name (with layers icon)
  • Last Connected - Timestamp showing when you last connected to this database
  • Action Button - "Connect" button for disconnected databases, "Disconnect" button for connected ones

Quick Connect/Disconnect

Click on a connection card or its action button to quickly connect or disconnect:

  • Connect - Clicking a disconnected connection shows a confirmation dialog, then initiates the connection
  • Disconnect - Clicking a connected connection shows a confirmation dialog before safely disconnecting

Tip: The recent connections list automatically updates as you connect to different databases throughout your VisualLeaf session.

Video WELC10 Managing Connections - How to connect, disconnect, and work with recent connections

Quick Actions

The Quick Start section provides one-click access to the most common VisualLeaf operations.

View Connections

Opens the connections sidebar on the left side of the application. From here, you can browse all your configured connections organized by projects and environments. Click on any database or collection to start working with it.

Requires: Active license

Connection Manager

Opens the full Connection Manager dialog where you can create new connections, organize them into projects and environments, edit connection settings, and manage all your database configurations in one place.

Requires: Active license

MongoDB Atlas

Opens MongoDB Atlas registration page in your browser. MongoDB Atlas offers free cloud-hosted MongoDB databases perfect for testing and small projects. This is an external link that works regardless of license status.

Requires: None (external link)

Register License

Opens the VisualLeaf license registration portal in your browser. Here you can purchase a license, start a trial, or manage your existing license. This button only appears when you don't have an active license.

Note: Replaced by license info card when logged in

Help & Resources

The "Need Help?" bar at the bottom of the Welcome Screen provides quick access to learning resources and support.

Help resources bar showing icons for Docs, Keys, Videos, and Help

Docs

Opens the comprehensive VisualLeaf documentation in a new tab. Browse feature guides, tutorials, and reference materials to master every aspect of the application.

Help

Opens the feedback and support form. Submit bug reports, feature requests, or questions to the VisualLeaf support team directly from the application.

Video WELC12 Navigating VisualLeaf - Tour of the main interface, help resources, and productivity tips

Next Steps

Once you're familiar with the Welcome Screen, here's how to start working with your MongoDB databases:

  1. Activate Your License - If you haven't already, click "Login" or "Register" to activate VisualLeaf
  2. Create a Connection - Click "Connection Manager" and set up your first database connection
  3. Explore the Sidebar - Click "View Connections" to open the navigation sidebar and browse your databases
  4. Open a Collection - Click on any collection in the sidebar to start viewing and querying data
  5. Learn the Interface - Familiarize yourself with tabs, split panels, and the status bar

New User? Consider reading the documentation sections on Sidebar Navigation, Collection Activity, and Layout System to understand VisualLeaf's core interface.

How to Update VisuaLeaf

When a new version of VisuaLeaf is available, you'll receive a notification at the bottom of the application. Here's how to update:

  1. Check for Updates - Look for the update notification at the bottom of the app when a new version is available
  2. Download the New Version - Click the notification to be redirected to the download section of our landing page
  3. Install the New Version - Download and install the latest version of VisuaLeaf
  4. Uninstall the Old Version - Remove the previous version from your system

Your Data is Safe

Don't worry about losing your data during the update process. All your local data is preserved, including:

  • Saved connections and connection settings
  • Previous jobs and task history
  • Saved queries and shell scripts
  • Workspace configurations
  • User preferences and settings

Tip: We recommend keeping your VisuaLeaf installation up to date to benefit from the latest features, performance improvements, and security patches.

Pro Tips

  1. The Recent Connections panel saves you time - your most-used databases are always one click away.
  2. Watch the trial badge color in your license status. Red means you have 3 or fewer days remaining before expiration.
  3. You can connect and disconnect from the Recent Connections panel without opening the full sidebar.
  4. The Welcome Screen is your home base - you can always return here by clicking the home icon in the navigation.
  5. Organize your connections into projects from the Connection Manager for better organization, especially when managing multiple environments.
  6. Bookmark the help resources that you use most frequently - the Docs link opens the full manual in a new tab for easy reference.
  • Sidebar - Learn how to navigate through databases, collections, and views in the connections sidebar
  • Connection Manager - Detailed guide to creating and organizing database connections
  • Layout System - Understand tabs, split panels, and workspace management
  • Status Bar - Reference for the status bar indicators at the bottom of the application
  • Workspace Manager - Learn how to save and restore your workspace layout and open tabs

Ready to try VisuaLeaf?

Download and start managing your MongoDB databases with ease.

Download Free Trial