Getting started

Web and desktop

NeoSQL comes as a web app you open in a browser and a desktop app you install on Windows or macOS. Both use the same screens, but they reach your database by different routes, so the databases you can connect to and the features you can use differ. This page explains the differences and which to use when.

How the app reaches your database

The screens in the browser or the app do not connect to databases directly. Database connections are handled by the local server on desktop and by the NeoSQL server on the web. Where the server runs is the biggest difference between the two apps.

Web appDesktop app
Server that handles database connectionsA server run by NeoSQLA local server that runs with the app on this PC
Databases you can connect toDatabases that accept connections from the internet. The database's firewall must not block connections coming from the NeoSQL serverAny database this PC can reach: databases on the company network and behind a VPN, localhost databases on this PC, SQLite and H2 files
  • Company database firewalls usually allow connections only from developers' PCs. That is why you need the desktop app to work with company databases.
  • Use localhost, SQLite and H2 Embedded connections in the desktop app. If the Desktop-only Connection notice appears, open the connection on desktop.
  • The desktop app's local server accepts connections only from inside this PC (127.0.0.1). Other PCs cannot use it to reach your databases.

Sign-in and projects

Web appDesktop app
Sign-inAlways required. If you are not signed in, you are taken to the sign-in screenWorks without signing in. Signing in adds account features
Projects you can createAccount projectsLocal projects when not signed in. When signed in, choose local or account
Where projects are storedThe NeoSQL serverLocal projects on this PC, account projects on the NeoSQL server
Database connection details (passwords)Stored encrypted on the NeoSQL serverFor local projects, in the OS secure storage of this PC. For account projects, the same as the web
  • An account project opens as the same project on the web and on the desktop. A local project opens only in the desktop app on the PC where it was created.
  • A project's type is decided when you create it and cannot be changed later. Why is explained in Sign-in and project types, and how connection details are stored in Security and where your data goes.

Where to use each feature

FeatureEnvironment and workflow
Using the app without signing in, local projectsUse the desktop app. On the web, sign in and use account projects.
Company-network, VPN, localhost, SQLite and H2 file databasesUse the desktop app on a device that can reach the database.
Switching projects (Work tabs)Use work tabs on desktop or browser tabs on the web.
The Explorer context menuData Export... menu and the Explorer context menuData Import... menuExport data to files or import it from files in the desktop app.
The Explorer context menuNative Backup... menu and the Explorer context menuNative Reload... menuBack up and restore databases in the desktop app.
Exporting SQL results to CSV, JSON or ExcelUse the desktop app.
Saving generated source codeInstall into a project folder or download as ZIP on desktop. Download as ZIP on the web.
Importing and exporting template packsUse folders or ZIP files on desktop, or ZIP files on the web.
Adding custom JDBC driversAdd driver JAR files in the desktop app.
MCPConfigure external AI clients with the MCP Client Setup button in the desktop app.
AI models and API keysOn desktop, use the API Keys on This Device group and AI servers on this device or the company network. On the web, use account keys and public HTTPS addresses.
Storing the zero-knowledge secret keySave it in the OS keychain in the desktop app.
Updates (Install and update)Use automatic updates on desktop. On the web, refresh the page when a new version notice appears.

What differs in the web app

  • There is a Desktop App button at the right of the header. Clicking it opens the website where you download the desktop app.
  • In the web app, the number of rows fetched for SQL results is capped depending on your plan. The differences between plans are explained in Plans and features.
  • Use the web app in a desktop browser. Use the website on a phone.

Which one to use

WhenUse
You work with databases inside your company, behind a VPN or on your PCThe desktop app
You want to try it right away without an accountThe desktop app (without signing in). The web app requires signing in.
Project data must not leave your PCThe desktop app, with local projects and without signing in
You work with databases open to the internet (cloud databases and the like) on a PC where you cannot install appsThe web app
You design together with your teamAccount projects (web or desktop). To invite teammates, use a plan with sharing for at least two people. See Collaboration and permissions.
You want external AI tools (MCP) to work with NeoSQLThe desktop app

You can also use both. Sign in with the same account and you can open your account projects on the web and on the desktop. For example, you can work with company databases on the desktop and with databases open to the internet on the web.