@drael/code 0.2.0 → 0.3.0

package/README.md

@@ -1,84 +1,48 @@
 # @drael/code
 
-Points a coding client at [Drael](https://drael.sh). One command, and it asks before it
-writes.
+Points a coding client at [Drael](https://drael.sh).
 
 ```sh
 npx @drael/code
 ```
 
-It asks for your key and which client, and nothing else. Both can be flags instead:
+It asks for your key and which client, writes that client's own configuration file, and
+nothing else. Whatever it touches it copies first.
 
 ```sh
-npx @drael/code --key dk-YOUR-KEY --client kilo
+npx @drael/code --list        what it knows how to configure, and where
+npx @drael/code --dry-run     exactly what it would write, changing nothing
+npx @drael/code --uninstall   every file it changed, put back
+npx @drael/code --help        the flags
 ```
 
-## What it configures
-
-| Client     | File                          |
-| ---------- | ----------------------------- |
-| `opencode` | `~/.config/opencode/opencode.json` |
-| `kilo`     | `~/.config/kilo/kilo.jsonc`   |
-| `env`      | `~/.config/drael/env.sh`, for anything reading `OPENAI_BASE_URL` |
-
-All three are written `0600`, because a file holding an API key is not a file other
-accounts on the machine should read.
-
-The `kilo` file is **merged** rather than replaced: it is the whole extension's
-configuration and not ours, so the other providers and everything else in it are kept.
-
-## Undoing it
-
-```sh
-npx @drael/code --uninstall
-```
-
-Every file is copied before it is written, under `~/.local/state/drael/installer`.
-Uninstall puts the originals back byte for byte and removes the files that did not exist
-before. Installing twice keeps the **first** copy, so what an uninstall restores is the
-state before this ever touched the file.
-
-`--dry-run` prints exactly what would be written and changes nothing, including the copy.
-
-## The flags
-
-| Flag          | What it does                                                     |
-| ------------- | ---------------------------------------------------------------- |
-| `--key`       | The API key. Falls back to `DRAEL_KEY`, then to a prompt.         |
-| `--client`    | `opencode`, `kilo` or `env`. Without it you are asked.            |
-| `--host`      | For a local build or your own box. Defaults to `https://drael.sh`. |
-| `--list`      | Prints what it knows how to configure, and exits.                |
-| `--dry-run`   | Prints what would be written, and changes nothing.               |
-| `--uninstall` | Restores every file it changed, and exits.                       |
+Those four answer for themselves rather than being copied out here, so this page cannot
+go stale about which clients are supported, where their files live, or what the flags are.
 
 ## Why npx rather than `curl | sh`
 
 Piping a URL into a shell is exactly the pattern this product's own users are right to
-refuse. npx is already on the machine of anybody running an editor extension, and it
-makes Windows work without a second implementation to keep in step.
+refuse. npx is already on the machine of anybody running an editor extension, and it makes
+Windows work without a second implementation to keep in step.
 
-It makes one network call: `GET /v1/models` against the host it is configuring, to write
-the id that host actually serves rather than one assumed here. A host that does not
-answer is no reason to refuse to configure anything, so the published id stands in.
-
-That call is not a check. The last thing it prints is the `curl` that verifies the host
-and the key, for you to run yourself.
-
-The source is one file with one dependency, and it is short enough to read in a sitting.
-The people most right to distrust an opaque installer are this product's own users, so it
-earns the trust by being readable rather than by asking.
+It asks for no privilege, and it writes nothing outside the configuration file of the
+client you chose. The source is one file, short enough to read in a sitting: the people
+most right to distrust an opaque installer are this product's own users, so it earns the
+trust by being readable rather than by asking.
 
 ## Doing it by hand
 
-There is nothing privileged in what it writes. Any OpenAI-compatible client takes the
-same two values directly:
+There is nothing privileged in what it writes. The API is OpenAI-compatible, so any client
+takes a base URL and a key directly:
 
 ```sh
 export OPENAI_BASE_URL="https://drael.sh/v1"
 export OPENAI_API_KEY="dk-YOUR-KEY"
 ```
 
-The model id is `drael-v1`, and `GET /v1/models` is where it comes from. Full documentation at
-[drael.sh/docs/install](https://drael.sh/docs/install).
+## Everything else
+
+[drael.sh/docs/install](https://drael.sh/docs/install) is the documentation, and it is the
+copy that is kept current.
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drael/code",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Point your coding client at Drael.",
   "type": "module",
   "bin": {

package/src/code.js

@@ -443,6 +443,26 @@ function uninstall(args) {
   console.log()
 }
 
+/**
+ * The flags, from the tool rather than from a page about the tool. The README points here
+ * instead of repeating any of it, and a test holds this list to the flags the code reads.
+ */
+function help() {
+  masthead('into the editor you already use')
+  for (const [flag, said] of [
+    ['--key', 'the API key. Falls back to DRAEL_KEY, then to a prompt'],
+    ['--client', 'which one to configure. Without it, you are asked'],
+    ['--host', `for a local build or your own box. Defaults to ${DRAEL}`],
+    ['--list', 'what it knows how to configure, and where'],
+    ['--dry-run', 'exactly what it would write, changing nothing'],
+    ['--uninstall', 'every file it changed, put back'],
+    ['--help', 'this'],
+  ]) {
+    console.log(row(flag, dim(said)))
+  }
+  console.log()
+}
+
 function list() {
   console.log()
   for (const [name, client] of Object.entries(clients)) {
@@ -473,7 +493,7 @@ function parse(argv) {
     const arg = argv[i]
     if (!arg.startsWith('--')) continue
     const name = arg.slice(2)
-    if (['list', 'uninstall', 'dry-run'].includes(name)) {
+    if (['list', 'uninstall', 'dry-run', 'help'].includes(name)) {
       parsed[name] = true
       continue
     }
@@ -488,7 +508,9 @@ process.on('exit', () => process.stdout.write('\u001b[?25h'))
 
 const args = parse(process.argv.slice(2))
 
-if (args.list) {
+if (args.help) {
+  help()
+} else if (args.list) {
   list()
 } else if (args.uninstall) {
   uninstall(args)