{"id":14196887,"url":"https://github.com/achristmascarl/rainfrog","last_synced_at":"2025-05-12T13:26:47.987Z","repository":{"id":239958666,"uuid":"801100155","full_name":"achristmascarl/rainfrog","owner":"achristmascarl","description":"🐸 a database management tui","archived":false,"fork":false,"pushed_at":"2025-05-07T01:58:32.000Z","size":8434,"stargazers_count":3695,"open_issues_count":17,"forks_count":66,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-05-10T20:42:51.618Z","etag":null,"topics":["mysql","postgres","ratatui","rust","sqlite","terminal"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/rainfrog","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/achristmascarl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/funding.yaml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"achristmascarl"}},"created_at":"2024-05-15T15:35:44.000Z","updated_at":"2025-05-10T10:55:52.000Z","dependencies_parsed_at":"2024-05-21T01:42:12.767Z","dependency_job_id":"f2942d61-02aa-4171-a0e6-c574b68aa106","html_url":"https://github.com/achristmascarl/rainfrog","commit_stats":{"total_commits":187,"total_committers":10,"mean_commits":18.7,"dds":0.5454545454545454,"last_synced_commit":"b55b9b397fc688a8d3769b3e1781cfe986dabd1b"},"previous_names":["achristmascarl/rainfrog"],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achristmascarl%2Frainfrog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achristmascarl%2Frainfrog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achristmascarl%2Frainfrog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/achristmascarl%2Frainfrog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/achristmascarl","download_url":"https://codeload.github.com/achristmascarl/rainfrog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253480920,"owners_count":21915252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mysql","postgres","ratatui","rust","sqlite","terminal"],"created_at":"2024-08-18T23:01:04.696Z","updated_at":"2025-05-12T13:26:47.975Z","avatar_url":"https://github.com/achristmascarl.png","language":"Rust","funding_links":["https://github.com/sponsors/achristmascarl"],"categories":["Rust","Developer Tools","SQL Clients and IDE that Support DuckDB","\u003ca name=\"data-management-tabular\"\u003e\u003c/a\u003eData management - Tabular data","💻 Apps","Database Clients","Table of Contents"],"sub_categories":["Web Clients (WebAssembly)","⌨️ Development Tools"],"readme":"# 🐸 rainfrog\n\na database management tui\n\n![rainfrog demo](vhs/demo.gif)\n\n\u003e [!WARNING]\n\u003e rainfrog is currently in beta\n\nthe goal for rainfrog is to provide a lightweight, terminal-based alternative to\npgadmin/dbeaver.\n\n## features\n\n- efficient navigation via vim-like keybindings and mouse controls\n- query editor with keyword highlighting and session history\n- quickly copy data, filter tables, and switch between schemas\n- shortcuts to view table metadata and properties\n- cross-platform (macOS, linux, windows, android via termux)\n\n### why \"rainfrog\"?\n\n\u003e [frogs find refuge in elephant tracks](https://www.sciencedaily.com/releases/2019/06/190604131157.htm)\n\n### supported databases\n\nrainfrog has mainly been tested with postgres, and postgres will be the primary\ndatabase targeted. **mysql and sqlite are also supported, but they have not been \ntested as extensively as postgres**; use with caution, and check out the\n[known issues](#known-issues-and-limitations) section for things to look out for!\n\nthe postgres driver can also be used to connect to other databases that support \nthe postgres wire protocol, such as AWS Redshift. however, this functionality is not \nwell tested. in theory, the mysql driver should be able to do the same for databases \nthat support the mysql protocol. check each database's documentation for compatability.\n\n## disclaimer\n\nthis software is currently under active development; expect breaking changes,\nand use at your own risk. it is not recommended to use this tool with write\naccess on a production database.\n\n## table of contents\n\u003c!-- TOC start (generated with https://github.com/derlin/bitdowntoc) --\u003e\n\n- [installation](#installation)\n   * [cargo](#cargo)\n   * [homebrew](#homebrew)\n   * [arch linux](#arch-linux)\n   * [termux](#termux)\n   * [nix](#nix)\n   * [conda](#conda)\n   * [pixi](#pixi)\n   * [install script](#install-script)\n   * [release page binaries](#release-page-binaries)\n- [usage](#usage)\n   * [with connection options](#with-connection-options)\n   * [with connection url](#with-connection-url)\n   * [with environment variables](#with-environment-variables)\n   * [`docker run`](#docker-run)\n- [customization](#customization)\n   * [settings](#settings)\n   * [database connections](#database-connections)\n   * [keybindings](#keybindings)\n      + [n.b. for mac users](#nb-for-mac-users)\n      + [general](#general)\n      + [menu (list of schemas and tables)](#menu-list-of-schemas-and-tables)\n      + [query editor](#query-editor)\n      + [query history](#query-history)\n      + [query favorites](#query-favorites)\n      + [results](#results)\n- [exports](#exports)\n- [favorites](#favorites)\n- [roadmap](#roadmap)\n- [known issues and limitations](#known-issues-and-limitations)\n- [Contributing](#contributing)\n- [acknowledgements](#acknowledgements)\n\n\u003c!-- TOC end --\u003e\n\n\u003c!-- TOC --\u003e\u003ca name=\"installation\"\u003e\u003c/a\u003e\n## installation\n\n\u003c!-- TOC --\u003e\u003ca name=\"cargo\"\u003e\u003c/a\u003e\n### cargo\n\nafter installing rust (recommended to do so via\n[rustup](https://www.rust-lang.org/tools/install)):\n\n```sh\ncargo install rainfrog\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"homebrew\"\u003e\u003c/a\u003e\n### homebrew\n```sh\nbrew install rainfrog\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"arch-linux\"\u003e\u003c/a\u003e\n### arch linux\n\narch linux users can install from the\n[official repositories](https://archlinux.org/packages/extra/x86_64/rainfrog)\nusing [pacman](https://wiki.archlinux.org/title/pacman):\n\n```sh\npacman -S rainfrog\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"termux\"\u003e\u003c/a\u003e\n### termux\n\nif you are using [termux](https://termux.dev/), you'll need to install rust via\ntheir package manager:\n\n```sh\npkg install rust\n```\n\nand then make sure to install with termux features (and disable default\nfeatures):\n\n```sh\ncargo install rainfrog --features termux --no-default-features\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"nix\"\u003e\u003c/a\u003e\n### nix\n\n```sh\nnix-env -iA nixos.rainfrog\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"conda\"\u003e\u003c/a\u003e\n### conda\n\n```sh\nconda install -c conda-forge rainfrog\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"pixi\"\u003e\u003c/a\u003e\n### pixi\n\nThe command below installs rainfrog from conda-forge, the same repository as conda, but unlike conda it can be installed user-globally using [pixi](https://pixi.sh/).\n\n```sh\npixi global install rainfrog\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"install-script\"\u003e\u003c/a\u003e\n### install script\n\nthere is a simple install script that assists in downloading and unpacking a\nbinary from the release page to `~/.local/bin/`, which you might want to add to\nyour `PATH` variable if it isn't already there. you'll need to select which\nbinary is appropriate for your system (if you're not sure, you can find out by\ninstalling rust and running `rustc -vV` to see the \"host\" target), and the\nscript also needs [jq](https://github.com/jqlang/jq) and\n[fzf](https://github.com/junegunn/fzf) installed to run.\n\n```sh\ncurl -LSsf https://raw.githubusercontent.com/achristmascarl/rainfrog/main/install.sh | bash\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"release-page-binaries\"\u003e\u003c/a\u003e\n### release page binaries\n\n1. manually download and unpack the appropriate binary for your os from the\n   latest [release](https://github.com/achristmascarl/rainfrog/releases) (if\n   you're not sure which binary to pick, you can find out by installing rust and\n   running `rustc -vV` to see the \"host\" target)\n2. move the binary to a folder in your `PATH` environment variable\n\n\u003c!-- TOC --\u003e\u003ca name=\"usage\"\u003e\u003c/a\u003e\n## usage\n\n```sh\nUsage: rainfrog [OPTIONS]\n\nOptions:\n  -M, --mouse \u003cMOUSE_MODE\u003e   Whether to enable mouse event support. If enabled, the default mouse event handling for your terminal\n                             will not work. [possible values: true, false]\n  -u, --url \u003cURL\u003e            Full connection URL for the database, e.g. postgres://username:password@localhost:5432/dbname\n      --username \u003cUSERNAME\u003e  Username for database connection\n      --password \u003cPASSWORD\u003e  Password for database connection\n      --host \u003cHOST\u003e          Host for database connection (ex. localhost)\n      --port \u003cPORT\u003e          Port for database connection (ex. 5432)\n      --database \u003cDATABASE\u003e  Name of database for connection (ex. postgres)\n      --driver \u003cDRIVER\u003e      Driver for database connection (ex. postgres)\n  -h, --help                 Print help\n  -V, --version              Print version\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"with-connection-options\"\u003e\u003c/a\u003e\n### with connection options\n\nif any options are not provided, you will be prompted to input them.\nif you do not provide an input, that option will\ndefault to what is in your environment variables.\n\n```sh\nrainfrog \\\n  --driver \u003cdb_driver\u003e \\\n  --username \u003cusername\u003e \\\n  --host \u003chostname\u003e \\\n  --port \u003cdb_port\u003e \\\n  --database \u003cdb_name\u003e\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"with-connection-url\"\u003e\u003c/a\u003e\n### with connection url\n\nthe `connection_url` must include all the necessary options for connecting\nto the database (ex. `postgres://username:password@localhost:5432/postgres`).\nit will take precedence over all connection options.\n\n```sh\nrainfrog --url $(connection_url)\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"with-environment-variables\"\u003e\u003c/a\u003e\n### with environment variables\nif `connection_url` is not present, rainfrog will first check your `DATABASE_URL`\nenvironment variable, then it will check for `DATABASE_URL` in a `.env` file in\nthe current directory or a parent directory.\n\n\u003c!-- TOC --\u003e\u003ca name=\"docker-run\"\u003e\u003c/a\u003e\n### `docker run`\n\nfor postgres and mysql, you can run it by specifying all\nof the options as environment variables:\n\n```sh\ndocker run --platform linux/amd64 -it --rm --name rainfrog \\\n  --add-host host.docker.internal:host-gateway \\\n  -e db_driver=\"db_driver\" \\\n  -e username=\"\u003cusername\u003e\" \\\n  -e password=\"\u003cpassword\u003e\" \\\n  -e hostname=\"host.docker.internal\" \\\n  -e db_port=\"\u003cdb_port\u003e\" \\\n  -e db_name=\"\u003cdb_name\u003e\" achristmascarl/rainfrog:latest\n```\n\nif you want to provide a custom combination of\noptions and omit others, you can override the Dockerfile's\nCMD like so:\n\n```sh\ndocker run --platform linux/amd64 -it --rm --name rainfrog \\\n  achristmascarl/rainfrog:latest \\\n  rainfrog # overrides CMD, additional options would come after\n```\n\nsince sqlite is file-based, you may need to mount a path to\nthe sqlite db as a volume in order to access it:\n\n```sh\ndocker run --platform linux/amd64 -it --rm --name rainfrog \\\n  -v ~/code/rainfrog/dev/rainfrog.sqlite3:/rainfrog.sqlite3 \\\n  achristmascarl/rainfrog:latest \\\n  rainfrog --url sqlite:///rainfrog.sqlite3\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"customization\"\u003e\u003c/a\u003e\n## customization\n\nrainfrog can be customized by placing a `rainfrog_config.toml` file in\none of the following locations depending on your os, as determined by\nthe [directories](https://crates.io/crates/directories) crate:\n\n| Platform | Value                                                                   | Example                                                       |\n| -------- | ----------------------------------------------------------------------- | ------------------------------------------------------------- |\n| Linux    | `$XDG_CONFIG_HOME`/`_project_path_` or `$HOME`/.config/`_project_path_` | /home/alice/.config/barapp                                    |\n| macOS    | `$HOME`/Library/Application Support/`_project_path_`                    | /Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App |\n| Windows  | `{FOLDERID_LocalAppData}`\\\\`_project_path_`\\\\config                     | C:\\Users\\Alice\\AppData\\Local\\Foo Corp\\Bar App\\config          |\n\nyou can change the default config location by exporting an environment variable.\nto make the change permanent, add it to your .zshrc/.bashrc/.\\*rc file:\n\n```sh\nexport RAINFROG_CONFIG=~/.config/rainfrog\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"settings\"\u003e\u003c/a\u003e\n### settings\n\nright now, the only setting available is whether rainfrog\ncaptures mouse events by default. capturing mouse events\nallows you to change focus and scroll using the mouse.\nhowever, your terminal will not handle mouse events like it\nnormally does (you won't be able to copy by highlighting, for example).\n\n\u003c!-- TOC --\u003e\u003ca name=\"database-connections\"\u003e\u003c/a\u003e\n### database connections\n\ndatabase connections can be configured in the configuration file as shown below:\n\n```\n[db]\npostgres-local = { host = \"localhost\", driver = \"postgres\", port = 5432, database = \"postgres\", username = \"postgres\",  default = true }\npostgres-dev = { connection_string = \"postgresql://postgres:test123@127.0.0.1:5432\", driver = \"postgres\" }\nmysql-local = { host = \"localhost\", driver = \"mysql\", port = 32768, database = \"rainfrog\", username = \"root\" }\nsqlite-memory = { connection_string = \"sqlite://:memory:\", driver = \"sqlite\"}\nsqlite-disk = { connection_string = \"sqlite://./my_database.db\", driver = \"sqlite\"}\n```\n\nthe connection details can be provided in two formats: a raw connection string or specifying individual fields.\nconnections input are prioritized in the following order:\n\n- cli input\n- `DATABASE_URL` env variable\n- config file\n\nif no database connection in the config is set as the default connection, \na prompt will appear to select the desired database. The user will also be \nprompted for the password for the selected database and will have the option to \nstore it in a platform specific keychain for future reuse.\nfuture plans for database connections include switching database without having to restart rainfrog.\n\n\u003c!-- TOC --\u003e\u003ca name=\"keybindings\"\u003e\u003c/a\u003e\n### keybindings\n\nyou can customize some of the default keybindings, but not all of\nthem. to see a list of the ones you can customize, see the default\nconfig file at [.config/rainfrog_config.toml](./.config/rainfrog_config.toml). below\nare the default keybindings.\n\n\u003c!-- TOC --\u003e\u003ca name=\"nb-for-mac-users\"\u003e\u003c/a\u003e\n#### n.b. for mac users\non mac, for VS Code, terminal, kitty, and others, a setting for\n\"use option as meta key\" needs to be turned\non for Alt/Opt keybindings to work. (In VS Code, it's\n`\"terminal.integrated.macOptionIsMeta\": true` in the settings; in\nkitty, it's `macos_option_as_alt yes` in the config.)\n\n\u003c!-- TOC --\u003e\u003ca name=\"general\"\u003e\u003c/a\u003e\n#### general\n\n| keybinding                   | description                     |\n| ---------------------------- | ------------------------------- |\n| `Ctrl+c`                     | quit program                    |\n| `Alt+1`, `Ctrl+k`            | change focus to menu            |\n| `Alt+2`, `Ctrl+j`            | change focus to query editor    |\n| `Alt+3`, `Ctrl+h`            | change focus to results         |\n| `Alt+4`, `Ctrl+g`            | change focus to query history   |\n| `Alt+5`, `Ctrl+m`            | change focus to query favorites |\n| `Tab`                        | cycle focus forwards            |\n| `Shift+Tab`                  | cycle focus backwards           |\n| `q`, `Alt+q` in query editor | abort current query             |\n\n\u003c!-- TOC --\u003e\u003ca name=\"menu-list-of-schemas-and-tables\"\u003e\u003c/a\u003e\n#### menu (list of schemas and tables)\n\n| keybinding                   | description                       |\n| ---------------------------- | --------------------------------- |\n| `j`, `↓`                     | move selection down by 1          |\n| `k`, `↑`                     | move selection up by 1            |\n| `g`                          | jump to top of current list       |\n| `G`                          | jump to bottom of current list    |\n| `h`, `←`                     | focus on schemas (if more than 1) |\n| `l`, `→`                     | focus on tables                   |\n| `/`                          | filter tables                     |\n| `Esc`                        | clear filter                      |\n| `Backspace`                  | focus on tables                   |\n| `Enter` when searching       | focus on tables                   |\n| `Enter` with selected schema | focus on tables                   |\n| `Enter` with selected table  | preview table (100 rows)          |\n| `R`                          | reload schemas and tables         |\n\n\u003c!-- TOC --\u003e\u003ca name=\"query-editor\"\u003e\u003c/a\u003e\n#### query editor\n\nkeybindings may not behave exactly like vim. the full list of active\nVim keybindings in rainfrog can be found at [vim.rs](./src/vim.rs).\n\n| Keybinding        | Description                            |\n| ----------------- | -------------------------------------- |\n| `Alt+Enter`, `F5` | Execute query                          |\n| `j`, `↓`          | Move cursor down 1 line                |\n| `k`, `↑`          | Move cursor up 1 line                  |\n| `h`, `←`          | Move cursor left 1 char                |\n| `l`, `→`          | Move cursor right 1 char               |\n| `w`               | Move cursor to next start of word      |\n| `e`               | Move cursor to next end of word        |\n| `b`               | Move cursor to previous start of word  |\n| `0`               | Move cursor to beginning of line       |\n| `$`               | Move cursor to end of line             |\n| `gg`              | Jump to top of editor                  |\n| `G`               | Jump to bottom of current list         |\n| `Esc`             | Return to normal mode                  |\n| `i`               | Enter insert (edit) mode               |\n| `I`               | Enter insert mode at beginning of line |\n| `A`               | Enter insert mode at end of line       |\n| `o`               | Insert new line below and enter insert |\n| `v`               | Enter visual (select) mode             |\n| `V`               | Enter visual mode and select line      |\n| `r`               | Begin replace operation                |\n| `y`               | Begin yank (copy) operation            |\n| `x`               | Begin cut operation                    |\n| `p`               | Paste from clipboard                   |\n| `u`               | Undo                                   |\n| `Ctrl+r`          | Redo                                   |\n| `Ctrl+e`          | Scroll down                            |\n| `Ctrl+y`          | Scroll up                              |\n| `Ctrl+f`*, `Alt+f`  | Save query to favorites                |\n*only works in normal mode\n\n\u003c!-- TOC --\u003e\u003ca name=\"query-history\"\u003e\u003c/a\u003e\n#### query history\n\n| keybinding | description                   |\n| ---------- | ----------------------------- |\n| `j`, `↓`   | move selection down by 1      |\n| `k`, `↑`   | move selection up by 1        |\n| `g`        | jump to top of list           |\n| `G`        | jump to bottom of list        |\n| `y`        | copy selected query           |\n| `I`        | edit selected query in editor |\n| `D`        | delete all history            |\n\n\u003c!-- TOC --\u003e\u003ca name=\"query-favorites\"\u003e\u003c/a\u003e\n#### query favorites\n\n| keybinding | description                   |\n| ---------- | ----------------------------- |\n| `j`, `↓`   | move selection down by 1      |\n| `k`, `↑`   | move selection up by 1        |\n| `g`        | jump to top of list           |\n| `G`        | jump to bottom of list        |\n| `y`        | copy selected query           |\n| `I`        | edit selected query in editor |\n| `D`        | delete selected query         |\n| `/`        | filter favorites                     |\n| `Esc`      | clear filter                      |\n\n\u003c!-- TOC --\u003e\u003ca name=\"results\"\u003e\u003c/a\u003e\n#### results\n\n| keybinding                | description                    |\n| ------------------------- | ------------------------------ |\n| `P`                       | export results to csv          |\n| `j`, `↓`                  | scroll down by 1 row           |\n| `k`, `↑`                  | scroll up by 1 row             |\n| `h`, `←`                  | scroll left by 1 cell          |\n| `l`, `→`                  | scroll right by 1 cell         |\n| `b`                       | scroll right by 1 cell         |\n| `e`, `w`                  | scroll left by 1 column        |\n| `{`, `PageUp`, `Ctrl+b`   | jump up one page               |\n| `}`, `PageDown`, `Ctrl+f` | jump down one page             |\n| `g`                       | jump to top of table           |\n| `G`                       | jump to bottom of table        |\n| `0`                       | jump to first column           |\n| `$`                       | jump to last column            |\n| `v`                       | select individual field        |\n| `V`                       | select row                     |\n| `Enter`                   | change selection mode inwards  |\n| `Backspace`               | change selection mode outwards |\n| `y`                       | copy selection                 |\n| `Esc`                     | stop selecting                 |\n\n\u003c!-- TOC --\u003e\u003ca name=\"exports\"\u003e\u003c/a\u003e\n## exports\n\nquery results can be exported to csv. exporting is a blocking action, \nso be careful about exporting too many rows at once, as it will freeze \nthe application.\n\nthe file will be saved in your downloads directory, which is one of the \nfollowing depending on your os, as determined by\nthe [directories](https://crates.io/crates/directories) crate:\n\n|Platform | Value                  | Example                  |\n| ------- | ---------------------- | ------------------------ |\n| Linux   | `XDG_DOWNLOAD_DIR`     | /home/alice/Downloads    |\n| macOS   | `$HOME`/Downloads      | /Users/Alice/Downloads   |\n| Windows | `{FOLDERID_Downloads}` | C:\\Users\\Alice\\Downloads |\n\nyou can change the default export location by exporting an environment variable.\nto make the change permanent, add it to your .zshrc/.bashrc/.\\*rc file:\n\n```sh\nexport RAINFROG_EXPORT=~/Documents\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"favorites\"\u003e\u003c/a\u003e\n## favorites\n\nfrequently used queries can be saved as favorites. by default, \nfavorites are written to the application's data directory (the \nsame place that logs are written to), which is one of the \nfollowing depending on your os, as determined by \nthe [directories](https://crates.io/crates/directories) crate:\n\n|Platform | Value                                                                      | Example                                                       |\n| ------- | -------------------------------------------------------------------------- | ------------------------------------------------------------- |\n| Linux   | `$XDG_DATA_HOME`/`_project_path_` or `$HOME`/.local/share/`_project_path_` | /home/alice/.local/share/barapp                               |\n| macOS   | `$HOME`/Library/Application Support/`_project_path_`                       | /Users/Alice/Library/Application Support/com.Foo-Corp.Bar-App |\n| Windows | `{FOLDERID_LocalAppData}`\\\\`_project_path_`\\\\data                          | C:\\Users\\Alice\\AppData\\Local\\Foo Corp\\Bar App\\data            |\n\neach favorite will be a separate `.sql` file.\nyou can change the default export location by exporting an environment variable.\nto make the change permanent, add it to your .zshrc/.bashrc/.\\*rc file:\n\n```sh\nexport RAINFROG_FAVORITES=~/.config/rainfrog/favorites\n```\n\n\u003c!-- TOC --\u003e\u003ca name=\"roadmap\"\u003e\u003c/a\u003e\n## roadmap\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cb\u003e🏁 v0.1.0 – alpha\u003c/b\u003e\u003c/summary\u003e\n  \n- [x] scrollable table\n- [x] cancellable async querying (spawn tokio task)\n- [x] menu list with tables and schemas (collapsable)\n- [x] tui-textarea for query editor\n- [x] basic tui-textarea vim keybindings\n- [x] handle custom types / enums\n- [x] display rows affected\n- [x] confirm before delete/drop\n- [x] table selection and yanking\n- [x] multi-line pasting\n- [x] editor os clipboard support\n- [x] handle mouse events\n- [x] keybindings hints at bottom\n- [x] branch protection\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cb\u003e🏁 v0.2.0 – beta\u003c/b\u003e\u003c/summary\u003e\n\n- [x] vhs explainer gifs\n- [x] upgrade ratatui and tui-textarea\n- [x] shortcuts to view indexes, keys, etc.\n- [x] performant syntax highlighting\n- [x] session history\n- [x] changelog, release script\n- [x] handle explain / analyze output\n- [x] show query duration\n- [x] install script for bins\n\n\u003c/details\u003e\n\nnow that rainfrog is in beta, check out the\n[issues tab](https://github.com/achristmascarl/rainfrog/issues) for planned\nfeatures\n\n\u003c!-- TOC --\u003e\u003ca name=\"known-issues-and-limitations\"\u003e\u003c/a\u003e\n## known issues and limitations\n\n- geometry types are not currently supported\n- for x11 and wayland, yanking does not copy to the system clipboard, only\n  to the query editor's buffer. see \u003chttps://github.com/achristmascarl/rainfrog/issues/83\u003e\n- in visual mode, when selecting an entire line, the behavior is not the same as\n  vim's, as it simply starts the selection at the head of the line, so\n  moving up or down in lines will break the selection.\n- mouse events are only used for changing focus and scrolling; the editor does\n  not currently support mouse events, and menu items cannot be selected using\n  the mouse\n\nyou can find other reported issues in the\n[issues tab](https://github.com/achristmascarl/rainfrog/issues)\n\n\u003c!-- TOC --\u003e\u003ca name=\"contributing\"\u003e\u003c/a\u003e\n## Contributing\n\nfor bug reports and feature requests, please [create an issue](https://github.com/achristmascarl/rainfrog/issues/new/choose).\n\nplease read [CONTRIBUTING.md](./CONTRIBUTING.md) before opening issues\nor creating PRs.\n\n\u003c!-- TOC --\u003e\u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n## acknowledgements\n\n- [ratatui](https://github.com/ratatui-org/ratatui) (this project used ratatui's\n  [component template](https://github.com/ratatui-org/templates/tree/983aa3cb3b8dd743200e8e2a1faa6e7c06aad85e/component/template)\n  as a starting point)\n- [tui-textarea](https://github.com/rhysd/tui-textarea) (used in the query\n  editor)\n- [gobang](https://github.com/TaKO8Ki/gobang) (a rust db tui i drew inspiration\n  from)\n- [ricky rainfrog](https://us.jellycat.com/ricky-rain-frog/)\n- [rainfroggg](https://www.rainfrog.gg/) (my wife's tattoo studio)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachristmascarl%2Frainfrog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fachristmascarl%2Frainfrog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachristmascarl%2Frainfrog/lists"}