2021-10-31 16:07:53 +01:00
<!-- markdownlint - disable -->
2020-05-04 17:33:50 +02:00
< p align = "center" >
2021-03-14 15:38:55 +01:00
< img width = "800" src = "https://raw.githubusercontent.com/Fabio286/antares/master/docs/gh-logo.png" >
2020-05-04 17:33:50 +02:00
< / p >
2021-10-31 16:07:53 +01:00
<!-- markdownlint - restore -->
2020-05-04 17:33:50 +02:00
2020-07-24 14:05:14 +02:00
# Antares SQL Client
2020-05-04 17:33:50 +02:00
2021-08-16 19:44:55 +02:00
![GitHub package.json version ](https://img.shields.io/github/package-json/v/fabio286/antares ) ![GitHub ](https://img.shields.io/github/license/fabio286/antares ) [![Build Status ](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ffabio286%2Fantares%2Fbadge&style=flat )](https://actions-badge.atrox.dev/fabio286/antares/goto) [![antares ](https://snapcraft.io/antares/badge.svg )](https://snapcraft.io/antares) [![antares ](https://snapcraft.io/antares/trending.svg?name=0 )](https://snapcraft.io/antares) [![Twitter Follow ](https://img.shields.io/twitter/follow/AntaresSQL?style=social )](https://twitter.com/AntaresSQL) [![Plant a Tree ](https://raw.githubusercontent.com/Fabio286/treedom-badge/master/svg/plant-a-tree.svg )](https://www.treedom.net/en/user/fabio-di-stasio/event/antares-for-the-planet)
2020-07-29 15:56:29 +02:00
2020-08-07 17:27:25 +02:00
Antares is an SQL client based on [Electron.js ](https://github.com/electron/electron ) and [Vue.js ](https://github.com/vuejs/vue ) that aims to become a useful tool, especially for developers.
2021-07-27 17:18:11 +02:00
Our target is to support as many databases as possible, and all major operating systems, including the ARM versions.
2020-07-24 14:05:14 +02:00
2021-11-19 16:14:11 +01:00
**At the moment this application is in development state, many features will come in future updates**, and supports only MySQL/MariaDB, PostgreSQL and SQLite.
2022-07-23 02:22:07 +02:00
However, there are all the features necessary to have a pleasant database management experience, so give it a chance and send us your feedback, we would really appreciate it.
2021-07-07 12:59:27 +02:00
We are actively working on it, hoping to provide new cool features, improvements and fixes as soon as possible.
2020-07-24 14:05:14 +02:00
2021-03-31 10:59:19 +02:00
🔗 If you are curious to try Antares you can download and install the [latest release ](https://github.com/Fabio286/antares/releases/latest ).
2021-05-30 10:54:58 +02:00
👁 To stay tuned for new releases [follow Antares SQL ](https://twitter.com/AntaresSQL ) on Twitter.
2022-07-26 17:21:43 +02:00
🌟 Don't forget to **leave a star** if you appreciate this project.
🗳️ Poll: ** [Which is the main OS you use Antares on? ](https://github.com/antares-sql/antares/discussions/379 )**
2020-07-24 14:05:14 +02:00
2021-08-02 19:26:56 +02:00
## Current key features
- Multiple database connections at same time.
- Database management (add/edit/delete).
- Full tables management, including indexes and foreign keys.
- Views, triggers, stored routines, functions and schedulers management (add/edit/delete).
- A modern and friendly tab system; keep open every kind of tab you need in your workspace.
- Fake table data filler to generate tons of data for test purpose.
- Query suggestions and auto complete.
2021-09-30 09:05:40 +02:00
- Query history: search through the last 1000 queries.
2021-08-02 19:26:56 +02:00
- SSH tunnel support.
2022-02-16 08:57:54 +01:00
- Manual commit mode.
2022-03-12 17:42:34 +01:00
- Import and export database dumps.
2021-08-02 19:26:56 +02:00
- Dark and light theme.
- Editor themes.
2020-08-21 15:56:29 +02:00
## Philosophy
2020-08-10 18:09:33 +02:00
2021-07-07 12:59:27 +02:00
Why are we developing an SQL client when there are a lot of them on the market?
2022-04-05 14:06:36 +02:00
The main goal is to develop a **forever 100% free (without paid premium feature)** , full featured, as possible community driven, cross platform and open source alternative, empowered by JavaScript ecosystem.
2022-07-23 02:22:07 +02:00
A modern application created with minimalism and simplicity in mind, with features in the right places, not hundreds of tiny buttons, nested tabs or submenues; productivity comes first.
2020-08-10 18:09:33 +02:00
2021-08-02 19:26:56 +02:00
## Installation
2021-03-31 10:59:19 +02:00
2021-08-02 19:26:56 +02:00
Based on your operating system you can have one or more distribution formats to choose based on your preferences.
2022-07-23 02:22:07 +02:00
Since Antares SQL is a free software we don't have a budget to spend on annual licenses or certificates. This can result that on some platforms you might need to put in some additional work to install this app.
2021-03-31 10:59:19 +02:00
2021-08-02 19:26:56 +02:00
### Linux
2020-08-10 18:09:33 +02:00
2022-07-26 17:21:43 +02:00
On Linux you can simply download and run the `.AppImage` distribution, install from Snap Store, from AUR or from our [PPA repository ](https://github.com/antares-sql/antares-ppa ).
2020-08-10 18:09:33 +02:00
2021-08-02 19:26:56 +02:00
### Windows
2020-10-17 17:01:38 +02:00
2022-07-31 10:43:32 +02:00
On Windows you can choose between downloading the app from Microsoft Store or downloading the `.exe` from our [website ](https://antares-sql.app/downloads ) or [this github repo ](https://github.com/Fabio286/antares/releases/latest ). Distributions that are not from Microsoft Store are not signed with a certificate, so to install you need to click on "More info" and then "Run anyway" on SmartScreen prompt.
2021-08-02 19:26:56 +02:00
### MacOS
On macOS you can run `.dmg` distribution following [this guide ](https://support.apple.com/guide/mac-help/mh40616/mac ) to install apps from unknown developers.
## Download
[![Get it from the Snap Store ](https://snapcraft.io/static/images/badges/en/snap-store-black.svg )](https://snapcraft.io/antares) [![Get it from AUR ](https://raw.githubusercontent.com/Fabio286/antares/3e00c4bae6e036300c752c1a40c5a038fea9c169/docs/aur-badge.svg )](https://aur.archlinux.org/packages/antares-sql/) [![Get it from Microsoft Store ](https://raw.githubusercontent.com/Fabio286/antares/gh-pages/src/assets/ms-store.png )](https://www.microsoft.com/p/antares-sql-client/9nhtb9sq51r1?cid=storebadge& ocid=badge& rtc=1& activetab=pivot:overviewtab)
🚀 ** [Other Downloads ](https://github.com/Fabio286/antares/releases/latest )**
2020-10-17 17:01:38 +02:00
## Coming soon
2020-08-10 18:09:33 +02:00
This is a roadmap with major features will come in near future.
2021-04-03 12:17:40 +02:00
- Database tools.
2021-01-16 11:45:44 +01:00
- Users management (add/edit/delete).
2020-10-17 17:01:38 +02:00
- More context menu shortcuts.
- More keyboard shortcuts.
2021-11-19 16:14:11 +01:00
- Support for other databases.
2021-08-02 19:26:56 +02:00
- Apple Silicon distribution
2020-08-10 18:09:33 +02:00
2020-07-24 14:05:14 +02:00
## Currently supported
### Databases
- [x] MySQL/MariaDB
2021-07-07 12:59:27 +02:00
- [x] PostgreSQL
2021-11-19 16:14:11 +01:00
- [x] SQLite
2021-02-24 12:46:31 +01:00
- [ ] MSSQL
2020-07-24 14:05:14 +02:00
- [ ] OracleDB
- [ ] More...
### Operating Systems
2020-10-04 17:21:21 +02:00
#### • x64
2020-08-21 15:56:29 +02:00
2020-07-24 14:05:14 +02:00
- [x] Windows
2020-08-10 18:09:33 +02:00
- [x] Linux
2021-08-02 19:26:56 +02:00
- [x] MacOS
2020-07-29 15:56:29 +02:00
2020-08-21 15:56:29 +02:00
#### • ARM
- [ ] Windows
2021-05-15 21:47:30 +02:00
- [x] Linux
2021-05-22 16:24:19 +02:00
- [ ] MacOS
2020-08-21 15:56:29 +02:00
2021-08-02 19:26:56 +02:00
## How to contribute
- 🌍 [Translate Antares ](https://github.com/Fabio286/antares/wiki/Translate-Antares )
- 📖 [Contributors Guide ](https://github.com/Fabio286/antares/wiki/Contributors-Guide )
2022-03-29 15:47:50 +02:00
- 🚧 [Project Board ](https://github.com/antares-sql/antares/projects/1 )
2021-08-02 19:26:56 +02:00
2021-10-31 16:07:53 +01:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
2022-04-04 10:31:45 +02:00
< td align = "center" > < a href = "https://fabiodistasio.it/" > < img src = "https://avatars.githubusercontent.com/u/31471771?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Fabio Di Stasio< / b > < / sub > < / a > < br / > < a href = "https://github.com/antares-sql/antares/commits?author=Fabio286" title = "Code" > 💻< / a > < a href = "#translation-Fabio286" title = "Translation" > 🌍< / a > < a href = "https://github.com/antares-sql/antares/commits?author=Fabio286" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://www.linkedin.com/in/giulioganci/" > < img src = "https://avatars.githubusercontent.com/u/4192159?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Giulio Ganci< / b > < / sub > < / a > < br / > < a href = "https://github.com/antares-sql/antares/commits?author=toriphes" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://christianratz.de/" > < img src = "https://avatars.githubusercontent.com/u/2630316?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Christian Ratz< / b > < / sub > < / a > < br / > < a href = "https://github.com/antares-sql/antares/commits?author=digitalgopnik" title = "Code" > 💻< / a > < a href = "#translation-digitalgopnik" title = "Translation" > 🌍< / a > < / td >
2021-10-31 16:07:53 +01:00
< td align = "center" > < a href = "https://reverb6821.github.io/" > < img src = "https://avatars.githubusercontent.com/u/55198803?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Giuseppe Gigliotti< / b > < / sub > < / a > < br / > < a href = "#translation-reverb6821" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "https://github.com/Mohd-PH" > < img src = "https://avatars.githubusercontent.com/u/9362157?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Mohd-PH< / b > < / sub > < / a > < br / > < a href = "#translation-Mohd-PH" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "https://github.com/hongkfui" > < img src = "https://avatars.githubusercontent.com/u/37477191?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > hongkfui< / b > < / sub > < / a > < br / > < a href = "#translation-hongkfui" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "https://github.com/MrAnyx" > < img src = "https://avatars.githubusercontent.com/u/44176707?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Robin< / b > < / sub > < / a > < br / > < a href = "#translation-MrAnyx" title = "Translation" > 🌍< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "https://github.com/daeleduardo" > < img src = "https://avatars.githubusercontent.com/u/8599078?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Daniel Eduardo< / b > < / sub > < / a > < br / > < a href = "#translation-daeleduardo" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "https://ngoquocdat.com/" > < img src = "https://avatars.githubusercontent.com/u/56961917?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Ngô Quốc Đạt< / b > < / sub > < / a > < br / > < a href = "#translation-datlechin" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "https://github.com/IsamuSugi" > < img src = "https://avatars.githubusercontent.com/u/7746658?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Isamu Sugiura< / b > < / sub > < / a > < br / > < a href = "#translation-IsamuSugi" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "http://rsacchetto.nexxontech.it/" > < img src = "https://avatars.githubusercontent.com/u/18429412?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Riccardo Sacchetto< / b > < / sub > < / a > < br / > < a href = "#platform-Occhioverde" title = "Packaging/porting to new platform" > 📦< / a > < / td >
2022-04-04 10:31:45 +02:00
< td align = "center" > < a href = "https://kilianstallinger.com" > < img src = "https://avatars.githubusercontent.com/u/5290318?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Kilian Stallinger< / b > < / sub > < / a > < br / > < a href = "https://github.com/antares-sql/antares/commits?author=kilianstallz" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/wenj91" > < img src = "https://avatars.githubusercontent.com/u/12549338?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > 文杰< / b > < / sub > < / a > < br / > < a href = "https://github.com/antares-sql/antares/commits?author=wenj91" title = "Code" > 💻< / a > < / td >
2022-01-20 08:56:06 +01:00
< td align = "center" > < a href = "https://github.com/goYou" > < img src = "https://avatars.githubusercontent.com/u/62732795?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > goYou< / b > < / sub > < / a > < br / > < a href = "#translation-goYou" title = "Translation" > 🌍< / a > < / td >
2021-10-31 16:07:53 +01:00
< / tr >
2022-03-06 09:48:08 +01:00
< tr >
2022-04-04 10:31:45 +02:00
< td align = "center" > < a href = "https://github.com/raliqala" > < img src = "https://avatars.githubusercontent.com/u/30502407?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Topollo< / b > < / sub > < / a > < br / > < a href = "https://github.com/antares-sql/antares/commits?author=raliqala" title = "Code" > 💻< / a > < / td >
2022-03-22 21:38:21 +01:00
< td align = "center" > < a href = "https://github.com/SmileYzn" > < img src = "https://avatars.githubusercontent.com/u/5851851?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Cleverson< / b > < / sub > < / a > < br / > < a href = "#translation-SmileYzn" title = "Translation" > 🌍< / a > < / td >
2022-04-04 10:31:45 +02:00
< td align = "center" > < a href = "https://github.com/fredatgithub" > < img src = "https://avatars.githubusercontent.com/u/6720055?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > fred< / b > < / sub > < / a > < br / > < a href = "#translation-fredatgithub" title = "Translation" > 🌍< / a > < / td >
2022-05-23 16:13:06 +02:00
< td align = "center" > < a href = "https://github.com/xak666" > < img src = "https://avatars.githubusercontent.com/u/38811437?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > xaka_xak< / b > < / sub > < / a > < br / > < a href = "#translation-xak666" title = "Translation" > 🌍< / a > < / td >
2022-03-06 09:48:08 +01:00
< / tr >
2021-10-31 16:07:53 +01:00
< / table >
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!