pterm 0.0.15 → 0.0.17

package/README.md

@@ -108,9 +108,11 @@ Run a launcher. Equivalent to the user visiting a launcher page. Will run whiche
 ### syntax
 
 ```
-pterm run <launcher_path>
+pterm run <launcher_path_or_uri> [--open]
 ```
 
+- `--open`: (optional) open URL results in the browser. Default behavior is to print the URL to stdout without opening a browser.
+
 ### examples
 
 Launch the launcher in the current path
@@ -125,6 +127,141 @@ Launch from absolute path
 pterm run /pinokio/api/test
 ```
 
+Run from a launcher URI and auto-open the resulting URL in browser
+
+```
+pterm run https://github.com/example/my-launcher --open
+```
+
+## search
+
+Search installed or available apps.
+
+### syntax
+
+```
+pterm search [query words...]
+pterm search --q="<query>"
+pterm search "<query>" [--mode=balanced|broad|strict] [--min-match=<n>] [--limit=<n>]
+```
+
+- `--mode`: (optional) search strategy. `broad` (default), `balanced`, or `strict`.
+- `--min-match`: (optional) minimum number of query terms an app should match.
+- `--limit`: (optional) max number of app results to return.
+
+### examples
+
+```
+pterm search comfyui
+```
+
+```
+pterm search --q="text generation"
+```
+
+```
+pterm search "tts speech synthesis" --mode=balanced --min-match=2 --limit=8
+```
+
+## status
+
+Get app status by app id.
+
+### syntax
+
+```
+pterm status <app_id> [--probe] [--timeout=<ms>]
+```
+
+- `--probe`: (optional) actively probe app health.
+- `--timeout`: (optional) probe timeout in milliseconds.
+
+### examples
+
+```
+pterm status comfyanonymous-comfyui
+```
+
+```
+pterm status comfyanonymous-comfyui --probe --timeout=5000
+```
+
+## stars
+
+List starred apps.
+
+### syntax
+
+```
+pterm stars [query words...]
+pterm stars --q="<query>"
+```
+
+### examples
+
+```
+pterm stars
+```
+
+```
+pterm stars tts
+```
+
+## star
+
+Star an app so it is preferred on Pinokio home/search ranking.
+
+### syntax
+
+```
+pterm star <app_id>
+```
+
+### example
+
+```
+pterm star comfyanonymous-comfyui
+```
+
+## unstar
+
+Remove star from an app.
+
+### syntax
+
+```
+pterm unstar <app_id>
+```
+
+### example
+
+```
+pterm unstar comfyanonymous-comfyui
+```
+
+## logs
+
+Get app logs by app id.
+
+### syntax
+
+```
+pterm logs <app_id> [--script=<name>] [--tail=<lines>]
+```
+
+- `--script`: (optional) filter to a script.
+- `--tail`: (optional) return only the last N lines.
+
+### examples
+
+```
+pterm logs comfyanonymous-comfyui
+```
+
+```
+pterm logs comfyanonymous-comfyui --script=start --tail=200
+```
+
 ## filepicker
 
 Display a file picker dialog, which lets the user select one or more file or folder paths, powered by tkinter.
@@ -268,4 +405,3 @@ pterm push 'this is a notification' --sound
 ```
 pterm push 'this is an image notification' --image=icon.png
 ```
-

package/index.js

@@ -56,6 +56,12 @@ const isHttpUri = (value) => typeof value === "string" && /^https?:\/\//i.test(v
       await util.download(argv)
     } else if (cmd === "search") {
       await util.search(argv)
+    } else if (cmd === "stars") {
+      await util.stars(argv)
+    } else if (cmd === "star") {
+      await util.setStar(argv, true)
+    } else if (cmd === "unstar") {
+      await util.setStar(argv, false)
     } else if (cmd === "status") {
       await util.status(argv)
     } else if (cmd === "logs") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pterm",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "",
   "main": "index.js",
   "bin": {

package/rpc.js

@@ -2,6 +2,11 @@ const { WebSocket } = require('unws')
 class RPC {
   constructor(url) {
     this.url = url
+    this.wsOptions = {
+      headers: {
+        "x-pinokio-client": "pterm"
+      }
+    }
   }
   async status(rpc) {
     let res = await new Promise((resolve, reject) => {
@@ -38,7 +43,7 @@ class RPC {
       if (this.ws) {
         this.ws.send(JSON.stringify(rpc))
       } else {
-        this.ws = new WebSocket(this.url)
+        this.ws = new WebSocket(this.url, this.wsOptions)
         this.ws.addEventListener('open', () => {
           this.ws.send(JSON.stringify(rpc))
         });

package/script.js

@@ -52,7 +52,14 @@ class Script {
       stop()
     });
     let default_uri = await new Promise((resolve, reject) => {
-      rpc.run({ uri, mode: "open" }, (packet) => {
+      rpc.run({
+        uri,
+        mode: "open",
+        source: "pterm",
+        client: {
+          source: "pterm"
+        }
+      }, (packet) => {
         if (packet.data && packet.data.uri) {
           // start
           //rpc.stop({ uri })
@@ -134,9 +141,11 @@ class Script {
     });
     await rpc.run({
       uri,
+      source: "pterm",
       client: {
         cols,
         rows,
+        source: "pterm"
       }
     }, (packet) => {
       if (packet.type === "stop") {

package/util.js

@@ -9,8 +9,27 @@ class Util {
   }
   async search(argv) {
     const query = (argv._.slice(1).join(" ") || argv.q || "").trim()
+    const params = { q: query }
+    const mode = typeof argv.mode === "string" ? argv.mode.trim().toLowerCase() : ""
+    const minMatchRaw = argv.minMatch ?? argv["min-match"] ?? argv.min_match
+    const limitRaw = argv.limit
+    if (mode === "broad" || mode === "balanced" || mode === "strict") {
+      params.mode = mode
+    }
+    if (minMatchRaw !== undefined && minMatchRaw !== null && minMatchRaw !== "") {
+      const minMatch = Number.parseInt(String(minMatchRaw), 10)
+      if (Number.isFinite(minMatch) && minMatch > 0) {
+        params.min_match = String(minMatch)
+      }
+    }
+    if (limitRaw !== undefined && limitRaw !== null && limitRaw !== "") {
+      const limit = Number.parseInt(String(limitRaw), 10)
+      if (Number.isFinite(limit) && limit > 0) {
+        params.limit = String(limit)
+      }
+    }
     const response = await axios.get("http://localhost:42000/apps/search", {
-      params: { q: query }
+      params
     })
     this.printJson(response.data)
   }
@@ -52,6 +71,65 @@ class Util {
     const response = await axios.get(url)
     this.printJson(response.data)
   }
+  async stars(argv) {
+    const query = (argv._.slice(1).join(" ") || argv.q || "").trim().toLowerCase()
+    const [preferenceResponse, appResponse] = await Promise.all([
+      axios.get("http://localhost:42000/apps/preferences"),
+      axios.get("http://localhost:42000/info/apps")
+    ])
+    const preferenceItems = preferenceResponse && preferenceResponse.data && preferenceResponse.data.items
+      ? preferenceResponse.data.items
+      : {}
+    const apps = appResponse && appResponse.data && Array.isArray(appResponse.data.apps)
+      ? appResponse.data.apps
+      : []
+    const appsById = new Map()
+    for (const app of apps) {
+      if (!app || !app.name) continue
+      appsById.set(app.name, app)
+    }
+    const starredApps = Object.entries(preferenceItems)
+      .filter(([, preference]) => preference && preference.starred)
+      .map(([appId, preference]) => {
+        const app = appsById.get(appId) || {}
+        return {
+          app_id: appId,
+          title: app.title || appId,
+          description: app.description || "",
+          icon: app.icon || "/pinokio-black.png",
+          ...preference
+        }
+      })
+      .sort((a, b) => {
+        const aLast = typeof a.last_launch_at === "string" ? Date.parse(a.last_launch_at) || 0 : 0
+        const bLast = typeof b.last_launch_at === "string" ? Date.parse(b.last_launch_at) || 0 : 0
+        if (aLast !== bLast) {
+          return bLast - aLast
+        }
+        return String(a.title || a.app_id).localeCompare(String(b.title || b.app_id))
+      })
+      .filter((app) => {
+        if (!query) return true
+        const haystack = `${app.app_id || ""}\n${app.title || ""}\n${app.description || ""}`.toLowerCase()
+        return haystack.includes(query)
+      })
+    this.printJson({
+      q: query,
+      count: starredApps.length,
+      apps: starredApps
+    })
+  }
+  async setStar(argv, starred) {
+    if (argv._.length <= 1) {
+      console.error("required argument: <app_id>")
+      return
+    }
+    const appId = argv._[1]
+    const response = await axios.put(`http://localhost:42000/apps/preferences/${encodeURIComponent(appId)}`, {
+      starred: Boolean(starred)
+    })
+    this.printJson(response.data)
+  }
   async filepicker(argv) {
     const rpc = new RPC("ws://localhost:42000")
     if (argv.path) {