sideby 0.16.0 → 0.17.0

package/schemas/autostart.json

@@ -0,0 +1,165 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/autostart.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "supported",
+    "state",
+    "path",
+    "current"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "supported": {
+      "type": "boolean",
+      "description": "False on a system sideby cannot start at login yet; `reason` says so."
+    },
+    "reason": {
+      "type": "string"
+    },
+    "state": {
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "off"
+        },
+        {
+          "type": "string",
+          "const": "on"
+        },
+        {
+          "type": "string",
+          "const": "stale"
+        },
+        {
+          "type": "string",
+          "const": "foreign"
+        }
+      ],
+      "description": "`stale`: the Node or sideby it starts no longer exists; `foreign`: a file at that path that sideby did not write."
+    },
+    "path": {
+      "type": "string"
+    },
+    "programArguments": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "current": {
+      "type": "boolean",
+      "description": "The login item starts this sideby with this Node."
+    },
+    "missing": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "action": {
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "on"
+        },
+        {
+          "type": "string",
+          "const": "off"
+        }
+      ]
+    },
+    "changed": {
+      "type": "boolean"
+    },
+    "applied": {
+      "type": "boolean"
+    },
+    "content": {
+      "type": "string",
+      "description": "The file `on` writes."
+    },
+    "commands": {
+      "type": "array",
+      "items": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "loaded": {
+      "type": "boolean",
+      "description": "launchd took the change now."
+    },
+    "note": {
+      "type": "string"
+    },
+    "_notice": {
+      "type": "object",
+      "properties": {
+        "update": {
+          "type": "object",
+          "required": [
+            "current",
+            "latest",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "current": {
+              "type": "string"
+            },
+            "latest": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "Run it after the user agrees: it shows the plan and exits 10; then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        },
+        "skill": {
+          "type": "object",
+          "required": [
+            "installed",
+            "current",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "installed": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "The skill's version; null when it has none."
+            },
+            "current": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "`sideby update`, which updates the skill with sideby: run it after the user agrees; it shows the plan and exits 10, then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "description": "Not the answer to the task: mention it briefly afterwards and offer to update."
+    }
+  }
+}

package/schemas/config-get.json

@@ -0,0 +1,132 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/config-get.json",
+  "type": "object",
+  "required": [
+    "schemaVersion"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "file": {
+      "type": "string"
+    },
+    "keys": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "key",
+          "meaning",
+          "takes"
+        ],
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Dot path; `<…>` marks a part you fill in."
+          },
+          "meaning": {
+            "type": "string"
+          },
+          "takes": {
+            "type": "string"
+          },
+          "value": {},
+          "entries": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "key",
+                "value"
+              ],
+              "properties": {
+                "key": {
+                  "type": "string"
+                },
+                "value": {}
+              }
+            }
+          }
+        }
+      }
+    },
+    "key": {
+      "type": "string"
+    },
+    "set": {
+      "type": "boolean"
+    },
+    "value": {},
+    "meaning": {
+      "type": "string"
+    },
+    "takes": {
+      "type": "string"
+    },
+    "_notice": {
+      "type": "object",
+      "properties": {
+        "update": {
+          "type": "object",
+          "required": [
+            "current",
+            "latest",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "current": {
+              "type": "string"
+            },
+            "latest": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "Run it after the user agrees: it shows the plan and exits 10; then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        },
+        "skill": {
+          "type": "object",
+          "required": [
+            "installed",
+            "current",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "installed": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "The skill's version; null when it has none."
+            },
+            "current": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "`sideby update`, which updates the skill with sideby: run it after the user agrees; it shows the plan and exits 10, then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "description": "Not the answer to the task: mention it briefly afterwards and offer to update."
+    }
+  }
+}

package/schemas/config-set.json

@@ -0,0 +1,107 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/config-set.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "action",
+    "key",
+    "file",
+    "changed",
+    "applied"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "action": {
+      "anyOf": [
+        {
+          "type": "string",
+          "const": "set"
+        },
+        {
+          "type": "string",
+          "const": "unset"
+        }
+      ]
+    },
+    "key": {
+      "type": "string"
+    },
+    "file": {
+      "type": "string"
+    },
+    "changed": {
+      "type": "boolean"
+    },
+    "applied": {
+      "type": "boolean"
+    },
+    "before": {},
+    "after": {},
+    "_notice": {
+      "type": "object",
+      "properties": {
+        "update": {
+          "type": "object",
+          "required": [
+            "current",
+            "latest",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "current": {
+              "type": "string"
+            },
+            "latest": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "Run it after the user agrees: it shows the plan and exits 10; then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        },
+        "skill": {
+          "type": "object",
+          "required": [
+            "installed",
+            "current",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "installed": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "The skill's version; null when it has none."
+            },
+            "current": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "`sideby update`, which updates the skill with sideby: run it after the user agrees; it shows the plan and exits 10, then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "description": "Not the answer to the task: mention it briefly afterwards and offer to update."
+    }
+  }
+}

package/schemas/config.json

@@ -6,6 +6,67 @@
     "$schema": {
       "type": "string"
     },
+    "panel": {
+      "type": "object",
+      "properties": {
+        "theme": {
+          "type": "string",
+          "enum": [
+            "system",
+            "light",
+            "dark"
+          ],
+          "description": "Panel colours: follow the system (default), always light, or always dark."
+        },
+        "language": {
+          "type": "string",
+          "enum": [
+            "auto",
+            "en",
+            "zh"
+          ],
+          "description": "Panel language: the browser's (default), English, or Chinese."
+        }
+      },
+      "additionalProperties": false,
+      "description": "How the Panel looks (spec §3.29)."
+    },
+    "terminal": {
+      "type": "object",
+      "properties": {
+        "preferred": {
+          "type": "string",
+          "enum": [
+            "terminal",
+            "iterm2",
+            "ghostty",
+            "orca",
+            "wezterm",
+            "kitty",
+            "alacritty",
+            "custom"
+          ],
+          "description": "The terminal sideby opens for AI Tasks; without it sideby picks the one you use."
+        },
+        "custom": {
+          "type": "string",
+          "description": "Your own launch command for `preferred: custom`, with `{cwd}` and `{cmd}` placeholders."
+        }
+      },
+      "additionalProperties": false,
+      "description": "The terminal AI Tasks open in (spec §3.28)."
+    },
+    "ask": {
+      "type": "object",
+      "properties": {
+        "account": {
+          "type": "string",
+          "description": "The account AI Tasks start (`<family>:<name>` or a short command); sideby picks one without it."
+        }
+      },
+      "additionalProperties": false,
+      "description": "AI Tasks (spec §3.28)."
+    },
     "accounts": {
       "type": "object",
       "patternProperties": {
@@ -16,7 +77,8 @@
               "type": "array",
               "items": {
                 "type": "string"
-              }
+              },
+              "description": "Host arguments sideby starts the account with; `sideby config` and `sideby model` set only the model and effort ones."
             }
           },
           "additionalProperties": false
@@ -143,7 +205,8 @@
             "additionalProperties": false
           }
         }
-      }
+      },
+      "description": "Per family, more items each account shares with the main account: `{ path, mode }` with a relative path."
     },
     "accountTitle": {
       "type": "boolean",
@@ -209,13 +272,15 @@
                       "type": "string",
                       "const": "order"
                     }
-                  ]
+                  ],
+                  "description": "`pressure` picks the account with the most Quota left; `order` follows `order`."
                 },
                 "order": {
                   "type": "array",
                   "items": {
                     "type": "string"
-                  }
+                  },
+                  "description": "Accounts (ref or short command) to try, in order."
                 }
               },
               "additionalProperties": false
@@ -317,11 +382,13 @@
       "properties": {
         "zsh": {
           "type": "string",
-          "minLength": 1
+          "minLength": 1,
+          "description": "The file for zsh."
         },
         "bash": {
           "type": "string",
-          "minLength": 1
+          "minLength": 1,
+          "description": "The file for bash."
         }
       },
       "additionalProperties": false,

package/schemas/key.json

@@ -0,0 +1,93 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/key.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "account",
+    "var",
+    "written",
+    "path"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "account": {
+      "type": "string"
+    },
+    "var": {
+      "type": "string"
+    },
+    "written": {
+      "type": "boolean",
+      "const": true
+    },
+    "path": {
+      "type": "string"
+    },
+    "_notice": {
+      "type": "object",
+      "properties": {
+        "update": {
+          "type": "object",
+          "required": [
+            "current",
+            "latest",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "current": {
+              "type": "string"
+            },
+            "latest": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "Run it after the user agrees: it shows the plan and exits 10; then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        },
+        "skill": {
+          "type": "object",
+          "required": [
+            "installed",
+            "current",
+            "command",
+            "message"
+          ],
+          "properties": {
+            "installed": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "The skill's version; null when it has none."
+            },
+            "current": {
+              "type": "string"
+            },
+            "command": {
+              "type": "string",
+              "description": "`sideby update`, which updates the skill with sideby: run it after the user agrees; it shows the plan and exits 10, then --yes."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "description": "Not the answer to the task: mention it briefly afterwards and offer to update."
+    }
+  }
+}

package/schemas/local.json

@@ -98,6 +98,10 @@
     "restartedPanel": {
       "type": "boolean"
     },
+    "skillSynced": {
+      "type": "boolean",
+      "description": "Back on npm, `sideby update --yes` brought the sideby skill to that version (true) or failed (false)."
+    },
     "_notice": {
       "type": "object",
       "properties": {