![crate](https://www.rust-lang.org/logos/cargo.png)
# DBcat 
[![Crates.io](https://img.shields.io/crates/v/dbcat?style=for-the-badge)](https://crates.io/crates/dbcat)
[![License](https://img.shields.io/crates/l/dbcat?label=LICENSE&style=for-the-badge)](https://raw.githubusercontent.com/NishantJoshi00/dbcat/main/LICENSE)

A *cat(1)* equivalent for viewing sqlite database.


## Installation

- cargo:
    Install cargo from [Here!](https://www.rust-lang.org/tools/install)
    
    ```bash
    $ cargo install dbcat
     ```

### NetBSD ([Official repositories])
```sh
pkgin install dbcat
```

or, if you prefer to build it from source
```sh
cd /usr/pkgsrc/textproc/dbcat
make install
```

[Official repositories]: https://pkgsrc.se/textproc/dbcat

### Usage

Read the database simply by running 
```bash
$ dbcat <filename>.db
```

![Basic Usage](./assets/basic.gif)


---

Change the format of the output by choice or automatically if the output is a tty or not.

![Atty Usage](./assets/atty_example.gif)

---

Access individual tables by running 
```bash
$ dbcat [-t <table>] <filename>.db
```

![Tables Access](./assets/tables.gif)
---

Pass a filter query to filter the tables by running 

```bash
$ dbcat [-t <table>] -f <query> <filename>.db
```

![Filter Command](./assets/query.gif)
---

## Help

Use `dbcat --help` to see the help.

## Contribution

Your contribution is highly appreciated. Do not hesitate to open an issue or a
pull request. Note that any contribution submitted for inclusion in the project
will be licensed according to the terms given in [LICENSE](LICENSE.md).