@drael/code 0.1.0 → 0.3.0

package/README.md

@@ -0,0 +1,48 @@
+# @drael/code
+
+Points a coding client at [Drael](https://drael.sh).
+
+```sh
+npx @drael/code
+```
+
+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 --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
+```
+
+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.
+
+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. 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"
+```
+
+## 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.1.0",
+  "version": "0.3.0",
   "description": "Point your coding client at Drael.",
   "type": "module",
   "bin": {
@@ -10,7 +10,8 @@
     "src"
   ],
   "scripts": {
-    "ci": "node --check src/code.js"
+    "ci": "node --check src/code.js && node --test \"test/*.test.js\"",
+    "test": "node --test \"test/*.test.js\""
   },
   "engines": {
     "node": ">=20"
@@ -21,5 +22,15 @@
   },
   "dependencies": {
     "@clack/core": "^1.0.0"
-  }
+  },
+  "homepage": "https://drael.sh/docs/install",
+  "keywords": [
+    "drael",
+    "openai-compatible",
+    "installer",
+    "cli",
+    "opencode",
+    "kilo-code",
+    "llm"
+  ]
 }

package/src/code.js

@@ -63,6 +63,12 @@ const KILO_CONFIG = join(homedir(), '.config', 'kilo', 'kilo.jsonc')
 // it. Asking for the address was the installer failing to know its own address.
 const DRAEL = 'https://drael.sh'
 
+// The id the backend publishes today (`chat/transport.ModelID`), and a test holds the
+// two together. It is the fallback rather than the answer: what goes into the file is
+// what the host says it serves, so a version bump on the box reaches a config written
+// months earlier without anybody editing this.
+const MODEL = 'drael-v1'
+
 /* ──────────────────────────────────────────────────────────────────  the clients  ── */
 
 /**
@@ -76,7 +82,7 @@ const clients = {
   opencode: {
     label: 'OpenCode',
     file: () => join(CONFIG_HOME, 'opencode', 'opencode.json'),
-    contents: (host, key) =>
+    contents: (host, key, model) =>
       json({
         $schema: 'https://opencode.ai/config.json',
         provider: {
@@ -84,10 +90,10 @@ const clients = {
             npm: '@ai-sdk/openai-compatible',
             name: 'Drael',
             options: { baseURL: `${host}/v1`, apiKey: key },
-            models: { drael: { name: 'Drael' } },
+            models: { [model]: { name: 'Drael' } },
           },
         },
-        model: 'drael/drael',
+        model: `drael/${model}`,
       }),
   },
 
@@ -95,7 +101,7 @@ const clients = {
     label: 'Kilo Code',
     merges: true,
     file: () => KILO_CONFIG,
-    contents: (host, key) => {
+    contents: (host, key, model) => {
       const existing = readJson(KILO_CONFIG)
       return json({
         ...existing,
@@ -104,10 +110,10 @@ const clients = {
           ...existing.provider,
           drael: {
             options: { baseURL: `${host}/v1`, apiKey: key },
-            models: { drael: { name: 'Drael' } },
+            models: { [model]: { name: 'Drael' } },
           },
         },
-        model: 'drael/drael',
+        model: `drael/${model}`,
       })
     },
   },
@@ -268,6 +274,25 @@ const askClient = () =>
     }),
   )
 
+/**
+ * What the host says it serves, which is the same question `/v1/models` answers for the
+ * product itself. The one call this makes, and the only one: it is to the host being
+ * configured, with the key being configured, and a host that does not answer is not a
+ * reason to refuse to write anything, so the published id stands in.
+ */
+async function servedModel(host, key) {
+  try {
+    const response = await fetch(`${host}/v1/models`, {
+      headers: { Authorization: `Bearer ${key}` },
+      signal: AbortSignal.timeout(4000),
+    })
+    const served = (await response.json())?.data?.[0]?.id
+    return typeof served === 'string' && served ? served : MODEL
+  } catch {
+    return MODEL
+  }
+}
+
 /**
  * Whether the client's own directory is on this machine. It is a hint and never a gate:
  * a fresh install may not have written its directory yet, so every client stays on the
@@ -303,7 +328,7 @@ async function install(args) {
   }
 
   const file = client.file()
-  const contents = client.contents(host, key)
+  const contents = client.contents(host, key, await servedModel(host, key))
 
   // An answered prompt leaves its frame on screen and needs a gap after it. With every
   // answer given as a flag there was no frame, and the masthead's own gap is already it.
@@ -321,13 +346,16 @@ async function install(args) {
     return
   }
 
+  // Asked before the write, or it inspects the valid JSON we are about to put there.
+  const replaced = client.merges && !parses(file)
+
   const kept = backup(file)
   mkdirSync(dirname(file), { recursive: true })
   writeFileSync(file, contents, { mode: 0o600 })
   chmodSync(file, 0o600)
 
   console.log(row(client.merges ? 'merged' : 'wrote', tilde(file)))
-  if (client.merges && !parses(file)) {
+  if (replaced) {
     console.log(under(dim('it was not plain JSON, so it was replaced rather than merged')))
   }
   console.log(row(kept.label, dim(kept.detail)))
@@ -415,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)) {
@@ -445,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
     }
@@ -460,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)