Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moaqz/dbsh
📚 Tiny database management CLI
https://github.com/moaqz/dbsh
cli postgresql sqlite
Last synced: about 2 months ago
JSON representation
📚 Tiny database management CLI
- Host: GitHub
- URL: https://github.com/moaqz/dbsh
- Owner: moaqz
- License: mit
- Created: 2024-08-04T15:01:55.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T00:15:08.000Z (5 months ago)
- Last Synced: 2024-11-02T10:08:31.011Z (2 months ago)
- Topics: cli, postgresql, sqlite
- Language: TypeScript
- Homepage:
- Size: 166 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 🪐 Features
✅ Display detailed information about a specific table.
✅ Show schema definitions for all tables in the database.
✅ List all tables present in the database.
✅ Automatically load database connection URL from `.env` file.
more coming soon...
## ✨ Motivation
I'm not a big fan of tools like `pgAdmin` or `MySQL Workbench`. They are great tools, but they just provide more information than I need. I prefer using the CLIs that each database provides, but installing `sqlite3`, `psql`, and learning all the commands is a bit too much work for me 😅.
I wanted something simpler and easy to extend, so I decided to create my own tool to get information from my database without leaving my terminal.
The project is inspired by `artisan` (from Laravel) and `wrangler` (from Cloudflare).
## 🛠️ Usage
For one time use of the command, run the following command:
```bash
npx dbsh
```
To install the command globally, run the following command:
```bash
npm install -g dbsh
dbsh
```
## 🔭 Roadmap
Here's what you can expect in future releases:
- Support for more databases.
- An option to read the database connection URL from a configuration file, like `.env`. **(released in v0.2.0)**
- Include additional information such as indexes and foreign key definitions in the `table` command.
## 📃 License
Published under the [MIT](https://github.com/moaqz/dbsh/blob/main/LICENSE) license