Getting Started

Open the NeoSQL official site, sign in on the login page, and you'll land on the dashboard. Your active projects are listed; click "New Project" to create one or pick an existing project to continue. For full walkthroughs of sign-up, login, and project management, see the guides below.

• Sign Up guide
• Social Login guide
• Project Create / Edit / Delete guide

macOS Install (Apple Silicon)

How to install the NeoSQL desktop app on Apple Silicon Macs.

Windows Install

How to install the NeoSQL desktop app on Windows. Microsoft SmartScreen may show a prompt at the download stage and again at the execution stage, so follow the steps below in order.

1

Download the Installer

Download NeoSQL-win-x64-Setup.exe from the NeoSQL official site.

2

Bypass Download SmartScreen (Microsoft Edge)

Microsoft SmartScreen may temporarily block newly-published, unsigned files at the download stage. When a block notice appears, follow the flow shown in the image below to retain the file. (Microsoft Edge enforces SmartScreen more strictly than other browsers.)

3

Bypass Execution SmartScreen (Windows)

Run the downloaded installer. When Windows SmartScreen shows the "Windows protected your PC" dialog, click "More info" → "Run anyway" to continue.

4

Finish Install & Allow Firewall

Follow the installer wizard; shortcuts will be created on your desktop and Start menu. No environment variables or separate Java install is required, and the neosql:// deep-link handler is registered automatically. On first launch, if Windows Firewall prompts about network access, choose "Allow access" so NeoSQL can reach your databases.

Where Credentials Are Stored

The desktop app encrypts DB passwords and SSH keys in the OS-native secret store.

• macOS — Credentials are encrypted and stored in the macOS Keychain, scoped to the user account.
• Windows — Credentials are encrypted and stored in the Windows credential vault (DPAPI), scoped to the current user account.

Auto-Update

The desktop app checks for updates on launch and downloads them in the background. Once the download finishes, you'll see a prompt with "Restart Now" and "Later" options — choose "Later" to apply the update automatically the next time you quit the app. Auto-update does not run in air-gapped environments; IT must distribute new installer builds manually.

Getting Started

From the installed desktop app, click "Sign in via browser" — the default browser opens the NeoSQL login page, and once you authenticate, the neosql:// deep-link handler returns you to the desktop app automatically. From the dashboard you can create a new project or pick an existing one to start working. For full walkthroughs of sign-up, login, and project management, see the guides below.

• Sign Up guide
• Social Login guide
• Project Create / Edit / Delete guide

Entering Offline Mode

Launch the desktop app and click the "Offline Login" link at the bottom of the login screen to move to the license key entry form.

Apply License & Authenticate

Drag-and-drop (or upload) the JSON key file — the license key and the three parameters below auto-fill. Check "Remember Me" to keep them for next launch, then click "Offline Authentication" — once validated, you'll move to the project selection screen. When the license expires, the session ends automatically; within 24 hours before expiry, the app shows a warning to remind you to renew. If you don't have a key file or need to renew, see the Offline License guide.

Air-Gapped Deployment

IT administrators can roll out NeoSQL to air-gapped fleets like this:

1. On an internet-connected PC, download the desktop installer and the per-user license key files.
2. Transport installers and key files to air-gapped PCs over an approved channel — USB, internal file server, etc.
3. Each user installs the desktop app and registers their key file on the offline-mode entry screen.
4. Repeat the same procedure whenever updates or key renewals are needed.

Offline Project Management

In Offline mode, projects live on the local file system. Create a new project under a chosen directory, or open an existing directory that already has a .neosql/ folder.

Create a New Project

Open an Existing Project

Data Storage Location

In Offline mode, all working data is stored as JSON files inside the project's .neosql/ folder. Sensitive credentials (DB passwords, SSH keys) live in the OS-native secret store (macOS Keychain / Windows DPAPI) and never end up inside .neosql/.

{project-root}/.neosql/
├── project-config.json                        # Project settings (name, DBMS, template pack)
├── connections/                               # DB connection info
│   └── {connectionId}_{connectionName}/       # Per-connection directory
│       ├── connection.json                    # Connection settings (host, port, driver). Passwords excluded
│       └── {schemaName}/                      # Per-schema directory
│           ├── {tableName}.json               # Table definition (columns, indexes, FKs)
│           └── {tableName}_entity.json        # Java Entity mapping info
├── erd/                                       # ERD diagrams
│   └── {erdId}.json                           # ERD definition (nodes, edges, layout)
└── sql/                                       # SQL Editor files
    └── {sqlId}.json                           # SQL query body and result cache