sqlite-hub 0.16.0 → 0.17.0

package/README.md

@@ -18,6 +18,7 @@ SQLite Hub keeps that workflow sharp:
 - edit records in place with an SQL diff preview before saving
 - export tables and query results as CSV, TSV, Markdown, or duplicate them as a table
 - copy result columns with formatting, headers, first-10 previews, TXT export, and Markdown todo export
+- keep database-scoped Markdown documents with previews, autosave, imports, exports, and saved-query inserts
 - switch between recent databases with sidebar quick picks
 - create simple local backups of the active database
 - run and format SQL in a syntax-highlighted editor with history, messages, and performance metrics
@@ -65,6 +66,16 @@ Potentially destructive statements are tracked in query history, and SQLite Hub
 
 SQLite Hub stores query history per database. You can search SQL, titles, and notes; mark useful queries as saved; re-run previous queries; and execute saved queries from the CLI.
 
+### Documents
+
+Documents are local Markdown notes scoped to the active database. SQLite Hub creates a document folder per database, keeps the sidebar fixed while the editor and preview panes scroll independently, and autosaves changes after a short debounce. You can create, rename, delete, import `.md` files, export the current document as Markdown, and toggle the editor or preview pane as needed.
+
+The preview supports regular Markdown, ordered and unordered lists, tables, code blocks, links, and clickable task-list checkboxes. Documents can also pull context from saved SQL Editor queries:
+
+- Insert Table opens a saved-query picker and inserts that query's result using the same Markdown table export logic as the SQL Editor.
+- Insert Note opens saved queries that have notes and inserts the selected note directly into the document.
+- Markdown Todo column exports from query results can create a new document without embedding the original SQL query.
+
 ### Charts
 
 Create charts from chartable `SELECT` query-history entries. Charts can be saved per query, reopened later, and rendered from live query results.
@@ -123,6 +134,8 @@ SQLite Hub ships with a built-in CLI that lets you start the app or query inform
 ```bash
 sqlite-hub                  # start on default port 4173
 sqlite-hub --port:4174      # start on a custom port
+sqlite-hub --open           # open SQLite Hub in the browser
+sqlite-hub --config         # show port, URL, app version, and SQLite version
 sqlite-hub --help           # show help text
 sqlite-hub --version        # show version number
 ```
@@ -147,49 +160,123 @@ Shows an overview of all databases that have been opened in SQLite Hub, includin
 Retrieve details about a single database by its name (case-insensitive):
 
 ```bash
-sqlite-hub --database-path:Billly     # get the file path
-sqlite-hub --database-size:Billly     # get the file size (human-readable)
-sqlite-hub --database-lastopened:Billly  # get last opened timestamp
+sqlite-hub --database:Billly --path        # get the file path
+sqlite-hub --database:Billly --size        # get the file size
+sqlite-hub --database:Billly --lastopened  # get last opened timestamp
 ```
 
 ### List all tables in a database
 
 ```bash
-sqlite-hub --database-tables:Billly
+sqlite-hub --database:Billly --tables
 ```
 
 Opens the database in read-only mode and prints all table names, sorted alphabetically.
 
+### Inspect a table
+
+```bash
+sqlite-hub --database:Billly --table:companies
+```
+
+Prints table metadata such as columns, primary keys, foreign keys, indexes, row count, and row identity strategy.
+
 ### SQL Editor - Saved Queries
 
 List all saved queries for a database:
 
 ```bash
-sqlite-hub --database:Unit-00 --sqleditor
+sqlite-hub --database:Unit-00 --queries
 ```
 
 Execute a specific saved query by name:
 
 ```bash
-sqlite-hub --database:Unit-00 --sqleditor:"15min Posting Buckets without id 96"
+sqlite-hub --database:Unit-00 --execute:"15min Posting Buckets without id 96"
 ```
 
 This searches the query history for the given database, finds the matching saved query by title, executes it, and returns all results with metadata (row count, columns, timing, and data).
 
+Show the saved query SQL without executing it:
+
+```bash
+sqlite-hub --database:Unit-00 --query:"Stock Winners"
+```
+
+Show the saved notes for a query:
+
+```bash
+sqlite-hub --database:Unit-00 --notes:"TOP25 Loser and Winner EOD, T1, T3, T5"
+```
+
+Export a saved query using the same CSV, TSV, and Markdown export logic as the SQL Editor:
+
+```bash
+sqlite-hub --database:Unit-00 --export:"Stock Winners" --format:csv
+sqlite-hub --database:Unit-00 --export:"Stock Winners" --format:tsv
+sqlite-hub --database:Unit-00 --export:"Stock Winners" --format:md
+```
+
+The export is written to the current working directory using the generated query export filename.
+
+### Documents CLI
+
+List all Markdown documents stored for a database:
+
+```bash
+sqlite-hub --database:Unit-00 --documents
+```
+
+Print one document's Markdown content:
+
+```bash
+sqlite-hub --database:Unit-00 --documents:"Research Notes"
+```
+
+Export one document as a `.md` file into the current working directory:
+
+```bash
+sqlite-hub --database:Unit-00 --documents:"Research Notes" --export
+sqlite-hub --database:Unit-00 --documents:"Research Notes--export"
+```
+
+Documents can be matched by id, filename, title, or a partial filename/title match.
+
+### Row JSON export
+
+Export a single row as JSON by primary key or rowid, using the same row-shaping logic as the Row Editor:
+
+```bash
+sqlite-hub --database:Unit-00 --table:companies --export:0a754aba373d34972998792a0be4333c
+```
+
 ### Available flags
 
-| Flag                                  | Description                           |
-| ------------------------------------- | ------------------------------------- |
-| `--help`, `-h`                        | Show help text                        |
-| `--version`, `-v`                     | Show version number                   |
-| `--port:PORT`                         | Start the server on a custom port     |
-| `--database`, `-d`                    | List all imported databases           |
-| `--database-path:name`                | Get the file path of a database       |
-| `--database-size:name`                | Get the size of a database            |
-| `--database-lastopened:name`          | Get the last opened timestamp         |
-| `--database-tables:name`              | Get all table names from a database   |
-| `--database:name --sqleditor`         | List all saved queries for a database |
-| `--database:name --sqleditor:"query"` | Execute a saved query by name         |
+| Flag                                                     | Description                                     |
+| -------------------------------------------------------- | ----------------------------------------------- |
+| `--help`, `-h`                                           | Show help text                                  |
+| `--version`, `-v`                                        | Show version number                             |
+| `--config`                                               | Show port, URL, app version, and SQLite version |
+| `--open`                                                 | Open SQLite Hub in the browser                  |
+| `--port:PORT`                                            | Start the server on a custom port               |
+| `--database`, `-d`                                       | List all imported databases                     |
+| `--database:name`                                        | Select a database by name or id                 |
+| `--database:name --path`                                 | Get the file path of a database                 |
+| `--database:name --size`                                 | Get the size of a database                      |
+| `--database:name --lastopened`                           | Get the last opened timestamp                   |
+| `--database:name --tables`                               | Get all table names from a database             |
+| `--database:name --queries`                              | List saved queries for a database               |
+| `--database:name --execute:"query"`                      | Execute a saved query by name                   |
+| `--database:name --query:"query"`                        | Print a saved query by name                     |
+| `--database:name --notes:"query"`                        | Print saved notes for a query                   |
+| `--database:name --export:"query" --format:csv\|tsv\|md` | Set query export format                         |
+| `--database:name --documents`                            | List Markdown documents for a database          |
+| `--database:name --documents:"document"`                 | Print a document's Markdown content             |
+| `--database:name --documents:"document" --export`        | Export a document as Markdown                   |
+| `--database:name --table:"table"`                        | Print table metadata                            |
+| `--database:name --table:"table" --export:"pk"`          | Export one row as JSON                          |
+
+Legacy aliases such as `--database-path:name`, `--database-size:name`, `--database-lastopened:name`, `--database-tables:name`, and `--database:name --sqleditor:"query"` still work.
 
 ### SQL editor CLI example
 
@@ -198,7 +285,7 @@ This searches the query history for the given database, finds the matching saved
 In the screenshot above, you can see a saved query from the SQL editor. You can create these queries using the graphical interface and execute them via the CLI if you want. To execute one, you would run:
 
 ```bash
-sqlite-hub --database:Unit-00 --sqleditor:"Group by creation Year"
+sqlite-hub --database:Unit-00 --execute:"Group by creation Year"
 ```
 
 Example output: