dirsql 0.3.78 → 0.3.80

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.
Files changed (2) hide show
  1. package/docs/reference/cli.md +11 -17
  2. package/package.json +11 -11
@@ -5,8 +5,8 @@ The `dirsql` binary has three modes:
5
5
  | Invocation | Behavior |
6
6
  |---|---|
7
7
  | `dirsql` (no subcommand) | Start a long-lived HTTP server exposing a SQL view of a directory. See [HTTP API](./http-api.md). |
8
- | `dirsql query "<sql>"` | Build the index, run one query, print the rows as JSON, exit. No server, no watch. |
9
- | `dirsql init` | Generate a starter `.dirsql.toml` by running `claude` over a directory. |
8
+ | `dirsql query "<sql>"` | Query the file system as JSON |
9
+ | `dirsql init` | Generate a `.dirsql.toml` |
10
10
 
11
11
  ## Installation
12
12
 
@@ -100,8 +100,7 @@ with a JSON body describing the failure:
100
100
 
101
101
  ## `dirsql query`
102
102
 
103
- Run one SQL query from the shell — for ad-hoc inspection, scripting, and
104
- docs verification snippets — without booting the server and `curl`ing it:
103
+ Run a SQL query from the shell:
105
104
 
106
105
  ```bash
107
106
  dirsql query "SELECT basename, size FROM files ORDER BY size DESC LIMIT 5"
@@ -140,34 +139,29 @@ stderr, with exit code `1`.
140
139
 
141
140
  ## `dirsql init`
142
141
 
143
- Generates a `.dirsql.toml` by running the `claude` CLI over the target
144
- directory. The generated config contains only filesystem-fact tables
145
- (`[[table]]` entries whose columns come from [glob captures and virtual
146
- columns](./columns.md)) — never content-derived columns.
142
+ Writes a starter `.dirsql.toml`:
147
143
 
148
144
  ```bash
149
145
  dirsql init
150
146
  ```
151
147
 
148
+ You can further tweak this config as needed.
149
+
152
150
  ### Flags
153
151
 
154
152
  | Flag | Default | Description |
155
153
  |---|---|---|
156
- | `--root <path>` | current directory | Directory to scan. |
157
- | `--output <path>` | `<root>/.dirsql.toml` | Where to write the generated config. |
154
+ | `--root <path>` | current directory | Directory the default `--output` path is resolved against. |
155
+ | `--output <path>` | `<root>/.dirsql.toml` | Where to write the config. |
158
156
  | `--force` | off | Overwrite the output file if it already exists. |
159
157
 
160
158
  ### Requirements and failure modes
161
159
 
162
- `init` requires `claude` on `PATH`, signed in; there is no separate API key.
163
160
  All failures exit `1` with a message on stderr:
164
161
 
165
162
  | Condition | Behavior |
166
163
  |---|---|
167
- | Output file exists and `--force` not passed | Fails before invoking `claude` (no LLM call is made). |
168
- | `claude` not found on `PATH` | Fails with a pointer to the Claude Code install docs. |
169
- | `claude` exits non-zero | Fails with `claude`'s stderr; no partial config is written. |
170
- | `claude` produces non-UTF-8 output | Fails; nothing is written. |
164
+ | Output file exists and `--force` not passed | Fails; nothing is written. |
165
+ | Output path unwritable (e.g. missing parent directory) | Fails with the underlying I/O error. |
171
166
 
172
- On success, `claude`'s stdout is written verbatim to the output path and
173
- `init` exits `0`.
167
+ On success, `init` exits `0`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dirsql",
3
- "version": "0.3.78",
3
+ "version": "0.3.80",
4
4
  "description": "Ephemeral SQL index over a local directory",
5
5
  "license": "MIT",
6
6
  "repository": "https://github.com/thekevinscott/dirsql",
@@ -230,15 +230,15 @@
230
230
  ]
231
231
  },
232
232
  "optionalDependencies": {
233
- "@dirsql/lib-linux-x64-gnu": "0.3.78",
234
- "@dirsql/lib-linux-arm64-gnu": "0.3.78",
235
- "@dirsql/lib-darwin-x64": "0.3.78",
236
- "@dirsql/lib-darwin-arm64": "0.3.78",
237
- "@dirsql/lib-win32-x64-msvc": "0.3.78",
238
- "@dirsql/cli-linux-x64-gnu": "0.3.78",
239
- "@dirsql/cli-linux-arm64-gnu": "0.3.78",
240
- "@dirsql/cli-darwin-x64": "0.3.78",
241
- "@dirsql/cli-darwin-arm64": "0.3.78",
242
- "@dirsql/cli-win32-x64-msvc": "0.3.78"
233
+ "@dirsql/lib-linux-x64-gnu": "0.3.80",
234
+ "@dirsql/lib-linux-arm64-gnu": "0.3.80",
235
+ "@dirsql/lib-darwin-x64": "0.3.80",
236
+ "@dirsql/lib-darwin-arm64": "0.3.80",
237
+ "@dirsql/lib-win32-x64-msvc": "0.3.80",
238
+ "@dirsql/cli-linux-x64-gnu": "0.3.80",
239
+ "@dirsql/cli-linux-arm64-gnu": "0.3.80",
240
+ "@dirsql/cli-darwin-x64": "0.3.80",
241
+ "@dirsql/cli-darwin-arm64": "0.3.80",
242
+ "@dirsql/cli-win32-x64-msvc": "0.3.80"
243
243
  }
244
244
  }