Docs/Getting Started

Quick Start Guide#

Get started with QueryMind in just a few minutes.

1. Launch QueryMind#

After installing QueryMind, launch the application.

2. Sign In or Use Guest Mode#

You have two options:

Sign In (Recommended)#

  • Click "Sign in with Google" or "Sign in with GitHub"
  • Complete the OAuth flow in your browser
  • You'll be automatically returned to the app

Guest Mode#

  • Click "Continue without login"
  • Limited to 1 database connection
  • AI features are disabled

3. Add a Database Connection#

  1. Click "+ Add Connection" in the sidebar or main screen

  2. Select your database type:

    • MySQL
    • PostgreSQL
    • MariaDB
    • Redis

  3. Enter connection details:

    • Name: A friendly name for this connection
    • Host: Database server address (e.g., localhost)
    • Port: Database port (default varies by type)
    • Username: Database user
    • Password: Database password
    • Database: (Optional) Default database to connect to

  4. Click "Test Connection" to verify

  5. Click "Save" to add the connection

4. Connect and Explore#

  1. Click the connection name in the sidebar to connect
  2. Expand the connection to see databases and tables
  3. Click a table to view its structure

5. Run Your First Query#

  1. Select the Query tab
  2. Type a SQL query in the editor: 
    SELECT * FROM users LIMIT 10;
  3. Press Cmd+Enter (Mac) or Ctrl+Enter (Windows/Linux) to execute

6. Try the AI Assistant#

  1. Click the AI Assistant button in the top-right
  2. Type a natural language request:

    "Show me all orders from the last 7 days with customer names"

  3. The AI will generate and explain the SQL query
  4. Click to execute the generated query

Next Steps#