diff options
| author | Joop Kiefte <ikojba@gmail.com> | 2023-09-28 22:44:02 +0100 |
|---|---|---|
| committer | Joop Kiefte <ikojba@gmail.com> | 2023-09-28 22:44:02 +0100 |
| commit | 05c5f0361e115d7eff52e56160efd40c6edbc98e (patch) | |
| tree | 62f6fb5ccd2901b7df47065eca14225c029fba4f | |
| parent | a04eb05bad8076fc17ecf887cf97355c834452a0 (diff) | |
Add some documentation to the README
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -1,3 +1,26 @@ # Debby Debby is a CLI tool that wraps Dolt and Visidata to enable you to do quick database and table interactions on the command line. + +## Instalation instructions + +1. Install VisiData. Any version should work, although I recommend getting a later version. +2. Install Dolt. Again, it should work with any version, but tested with the most recent ones. +3. Make sure you have Go installed for compiling debby. +4. `go install git.kiefte.eu/lapingvino/debby@latest` + +If you have ~/go/bin on your path, you can now invoke debby directly, otherwise you might want to move it to a location that is in your path. + +## Usage + +Debby has two main ways to use it. Running it without any arguments starts an interactive session. Here you can run any dolt command without the dolt part, +e.g. status, add and commit to perform a normal versioning sequence. Of course the sql command works as well, but debby's special sauce is in the run command +which will open the result of your query in visidata. If you want to do anything with this result, save it to a new file and e.g. import it. + +The edit command on the other hand just takes a table name as input but does import the changes back into dolt. It might not be the best option for massive tables, +but should be fine for most reasonable tables. + +The create command lets you create a table from scratch. You can edit the headers with ^, add new rows with a, add new columns with i, delete rows with d, hide columns with - (they are not deleted but everything hidden won't be saved) and edit any cell with e. Check the visidata documentation for more advanced tricks. When you are +done, debby will check the schema that dolt wants to give to this table and opens it in your default editor so you can adjust the schema before you submit it. + +That's it for now. Feel free to ping me about any suggestions for improvement! |