dirsql 0.4.117 → 0.4.119
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/reference/cli.md +17 -0
- package/package.json +6 -6
package/docs/reference/cli.md
CHANGED
|
@@ -237,6 +237,22 @@ On startup the server prints `Running at <host>:<port>` to stdout. It runs
|
|
|
237
237
|
until it receives `SIGINT` (Ctrl-C) or `SIGTERM`, then drains in-flight
|
|
238
238
|
requests, closes open `/events` streams, and exits.
|
|
239
239
|
|
|
240
|
+
Pass `--frontend` to serve the bundled dirsql SQL explorer shell at `/` on
|
|
241
|
+
the same origin as the HTTP API. It works offline and prints `Frontend at
|
|
242
|
+
http://<host>:<actual-port>/` without opening a browser. With `--port 0`, the
|
|
243
|
+
printed URL uses the assigned port. The initial shell shows server status;
|
|
244
|
+
query controls are coming in a subsequent update.
|
|
245
|
+
|
|
246
|
+
```bash
|
|
247
|
+
dirsql server --frontend
|
|
248
|
+
dirsql server --frontend -c .dirsql.toml
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
The shell reads `GET /frontend/state`: `{"error":null}` when the index is
|
|
252
|
+
ready, or HTTP `503` with `{"error":"<diagnostic>"}` when config loading
|
|
253
|
+
fails. Fix the config and restart the server. Without `--frontend`, the `/`
|
|
254
|
+
and `/frontend/state` routes return `404`.
|
|
255
|
+
|
|
240
256
|
### Flags
|
|
241
257
|
|
|
242
258
|
Config flags are subcommand-local: pass them after `server`
|
|
@@ -247,6 +263,7 @@ Config flags are subcommand-local: pass them after `server`
|
|
|
247
263
|
| `-c, --config <path>` | none | Path to a [config file](./config.md). **Repeatable** (`-c a -c b`): the configs load and merge in argv order — see [Composing multiple configs](./config.md#composing-multiple-configs). The index root is the **invocation directory** (the current working directory) and governs path-tables; a config's `[[table]]` globs anchor at **that config's own directory** (see [glob anchor](./config.md#glob-anchor)), so `--config /elsewhere/.dirsql.toml` indexes `/elsewhere`, from any working directory. With none given, **no named tables are defined** — query the filesystem with a [path-table](./path-tables.md) (`FROM './'`). A `./.dirsql.toml` on disk is **not** auto-loaded; pass it explicitly. A `-c` naming a file that does not exist is an [error](#degraded-mode). |
|
|
248
264
|
| `--host <addr>` | `localhost` | Bind address. |
|
|
249
265
|
| `--port <n>` | `7117` | TCP port to bind. |
|
|
266
|
+
| `--frontend` | off | Serve the bundled SQL explorer shell and print its URL. |
|
|
250
267
|
| `--cors-origin <origin>` | off | Let browser pages on `<origin>` (an exact origin such as `http://localhost:3202`, or `*` for any) call `/query` and open `/events`. See [Cross-origin requests](#cross-origin-requests). |
|
|
251
268
|
| `--persist [<path>]` | off | Keep the SQLite index on disk between runs so a restart only re-parses files that actually changed. Bare `--persist` caches under the platform cache directory (`$XDG_CACHE_HOME/dirsql/<root hash>/cache.db` on Linux), outside the root; `--persist <path>` caches at `<path>`. Off by default (the index is ephemeral). Also available on [`dirsql query`](#dirsql-query). See [Keep the index across restarts](../howto/persist.md). |
|
|
252
269
|
| `--no-ignore` | off | Scan files a `.gitignore` would hide. [Path-tables](./path-tables.md#skip-rules) respect `.gitignore` files by default; this flag restores the full walk. The built-in `.git` skip and configured `ignore` patterns still apply. Also available on [`dirsql query`](#dirsql-query). |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dirsql",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.119",
|
|
4
4
|
"description": "Ephemeral SQL index over a local directory",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": "https://github.com/thekevinscott/dirsql",
|
|
@@ -221,10 +221,10 @@
|
|
|
221
221
|
]
|
|
222
222
|
},
|
|
223
223
|
"optionalDependencies": {
|
|
224
|
-
"@dirsql/lib-linux-x64-gnu": "0.4.
|
|
225
|
-
"@dirsql/lib-linux-arm64-gnu": "0.4.
|
|
226
|
-
"@dirsql/lib-darwin-x64": "0.4.
|
|
227
|
-
"@dirsql/lib-darwin-arm64": "0.4.
|
|
228
|
-
"@dirsql/lib-win32-x64-msvc": "0.4.
|
|
224
|
+
"@dirsql/lib-linux-x64-gnu": "0.4.119",
|
|
225
|
+
"@dirsql/lib-linux-arm64-gnu": "0.4.119",
|
|
226
|
+
"@dirsql/lib-darwin-x64": "0.4.119",
|
|
227
|
+
"@dirsql/lib-darwin-arm64": "0.4.119",
|
|
228
|
+
"@dirsql/lib-win32-x64-msvc": "0.4.119"
|
|
229
229
|
}
|
|
230
230
|
}
|