Skip to main content

​
Requirements

Before installing Queryly, ensure you have the following:

.NET 8.0 SDK or later

Required to build and run Queryly

​
Verify .NET Installation

Check if you have .NET 8.0 SDK installed: 
dotnet --version
You should see version 8.0.0 or higher. If not, download it from dotnet.microsoft.com.

​
Build from Source

Currently, Queryly is installed by building from source. A global .NET tool package is coming soon.
1

Clone the repository

Clone the Queryly repository to your local machine:
git clone https://github.com/Ayine-nongre/queryly.git
cd queryly
2

Build the project

Build Queryly using the .NET CLI:
dotnet build
This will restore dependencies and compile the project. You should see a successful build message.
3

Run Queryly

Run Queryly using the dotnet run command:
dotnet run --project src/Queryly.CLI/Queryly.CLI.csproj
You should see the Queryly banner and help information:
  ___                        _       
 / _ \ _   _  ___ _ __ _   _| |_   _ 
| | | | | | |/ _ \ '__| | | | | | | |
| |_| | |_| |  __/ |  | |_| | | |_| |
 \__\_\\__,_|\___|_|   \__, |_|\__, |
                       |___/   |___/ 

Your local database companion
Queryly is a cross platform lightweight database manager for developers
and data enthusiasts. Manage your database connections, explore schemas,
browse data, and execute queries with ease.
--------------------------------------------------------
4

Create an alias (optional)

For convenience, create a shell alias to run Queryly easily:Bash/Zsh (~/.bashrc or ~/.zshrc):
alias queryly="dotnet run --project /path/to/queryly/src/Queryly.CLI/Queryly.CLI.csproj"
PowerShell (Microsoft.PowerShell_profile.ps1):
function queryly { dotnet run --project C:\path\to\queryly\src\Queryly.CLI\Queryly.CLI.csproj $args }
After adding the alias, reload your shell configuration or restart your terminal.

​
Install as Global Tool (Coming Soon)

In a future release, Queryly will be available as a .NET global tool for easier installation.
The future installation method will be: 
dotnet tool install -g queryly
Once installed as a global tool, you’ll be able to run queryly directly from anywhere: 
queryly connect list
queryly schema list MyDB

​
Verify Installation

Verify that Queryly is working correctly by running the help command: 
# If using the full command
dotnet run --project src/Queryly.CLI/Queryly.CLI.csproj

# Or if you created an alias
queryly
You should see the Queryly banner and a list of available commands.

​
Configuration Location

Queryly stores its configuration in your home directory: 
C:\Users\<username>\.queryly\
Configuration files:
  • connections.json - Stores your saved database connections
This directory is automatically created when you add your first connection.

​
Troubleshooting

Problem: The dotnet command is not recognized.Solution: Install the .NET 8.0 SDK from dotnet.microsoft.com. After installation, restart your terminal and verify with dotnet --version.
Problem: Build fails with package restoration errors.Solution: Clear your NuGet cache and restore:
dotnet nuget locals all --clear
dotnet restore
dotnet build
Problem: Permission errors when running on Linux/macOS.Solution: Ensure you have read/write permissions in the project directory:
chmod -R u+rwx /path/to/queryly

​
Next Steps

Now that Queryly is installed, learn how to use it:

Quick Start

Add your first database connection and explore your data

Command Reference

Learn all available Queryly commands

Build docs developers (and LLMs) love

Get started for freeTalk to us