sideby 0.3.0 → 0.4.1

package/package.json

@@ -1,17 +1,25 @@
 {
   "name": "sideby",
-  "version": "0.3.0",
-  "description": "Run every AI coding account side by side: Claude Code, Codex, Grok and pi, with one shared config and a quota panel.",
+  "version": "0.4.1",
+  "description": "Run work, personal and API-key accounts at the same time, without their configs drifting apart.",
   "license": "MIT",
+  "author": "Adonis0123 (https://github.com/Adonis0123)",
   "type": "module",
   "keywords": [
     "claude-code",
     "codex",
+    "codex-cli",
     "grok",
+    "grokbuild",
     "pi",
     "multi-account",
+    "account-manager",
+    "rate-limits",
+    "usage-monitor",
     "ai-coding",
+    "developer-tools",
     "cli",
+    "anthropic",
     "quota"
   ],
   "repository": {
@@ -54,7 +62,9 @@
     "schemas": "node src/cli/schemas.ts",
     "leak-check": "sh scripts/leak-check.sh",
     "check": "pnpm typecheck && pnpm lint && pnpm test && pnpm leak-check",
-    "version": "node scripts/sync-skill-version.ts && git add skills/sideby/SKILL.md"
+    "version": "node scripts/sync-skill-version.ts && git add skills/sideby/SKILL.md",
+    "prepublishOnly": "node scripts/pin-english-npm-readme.ts",
+    "postpublish": "node scripts/pin-english-npm-readme.ts --restore"
   },
   "dependencies": {
     "typebox": "^1.3.34"
@@ -64,5 +74,7 @@
     "@types/node": "^22.18.0",
     "typescript": "^7.0.2"
   },
-  "packageManager": "pnpm@10.15.0"
+  "packageManager": "pnpm@10.15.0",
+  "readmeFilename": "README.md",
+  "readme": "<p align=\"center\">\n  <img alt=\"sideby: work, personal and API-key accounts, one terminal each, one shared config\" src=\"https://raw.githubusercontent.com/Adonis0123/sideby/main/docs/assets/banner.jpg\" width=\"880\">\n</p>\n\n<p align=\"center\">\n  <b>Run work, personal and API-key accounts at the same time, without their configs drifting apart.</b><br>\n  Each account is its own directory and its own terminal. Skills, hooks and settings stay linked to your main account. Claude Code, Codex, Grok Build and pi.\n</p>\n\n<p align=\"center\">\n  <a href=\"https://www.npmjs.com/package/sideby\"><img alt=\"npm\" src=\"https://img.shields.io/npm/v/sideby\"></a>\n  <a href=\"https://github.com/Adonis0123/sideby/actions/workflows/ci.yml\"><img alt=\"CI\" src=\"https://github.com/Adonis0123/sideby/actions/workflows/ci.yml/badge.svg\"></a>\n  <img alt=\"Node 22.18+\" src=\"https://img.shields.io/badge/node-%E2%89%A522.18-339933\">\n  <a href=\"LICENSE\"><img alt=\"MIT\" src=\"https://img.shields.io/badge/license-MIT-blue\"></a>\n</p>\n\n<p align=\"center\">English | <a href=\"README.zh-CN.md\">中文</a></p>\n\n## Why not just an alias?\n\n`CLAUDE_CONFIG_DIR` plus a shell alias already starts a second account. It does not keep skills and settings in one place, and it does not show quota for every account. [Does this break a provider's terms?](docs/guide/faq.md#terms)\n\n| | At the same time | Skills, hooks, settings | Quota and usage | Setup |\n|---|---|---|---|---|\n| `CLAUDE_CONFIG_DIR` and an alias | Yes. Each terminal exports the variable. | Each directory is its own copy. They drift unless you symlink by hand. | That session's status line | One alias per account |\n| [cc-switch](https://github.com/farion1231/cc-switch) | Enabling a provider writes the host's live config, so open sessions share that switch. | Plugin settings are copied across providers as a separate step. | The active provider, from its quota endpoint | Install the desktop app |\n| sideby | Yes. `sideby run` selects the directory for that process and leaves your shell alone. | Linked to the main account. `sideby doctor --fix` repairs copies. Sign-in and sessions stay separate. | Every account, from local files. Claude needs `quota setup`. | `npm i -g sideby`, then `sideby new` and sign in |\n\ncc-switch's docs describe that switch: it writes the live settings file ([README](https://github.com/farion1231/cc-switch#readme)). [#1105](https://github.com/farion1231/cc-switch/issues/1105) and [#2908](https://github.com/farion1231/cc-switch/issues/2908) ask for several sessions at once. [#1106](https://github.com/farion1231/cc-switch/issues/1106) is closed; the maintainer says Claude Code's \"open terminal\" can start one provider without changing the global config.\n\n## Quick start\n\nRequires Node 22.18+ and at least one Host CLI (Claude Code, Codex, Grok Build or pi) installed. AI agents: follow the setup steps in [`llms.txt`](llms.txt) (\"Set up sideby for a user\") instead.\n\n```sh\nnpm i -g sideby\nsideby new claude work        # create ~/.claude-work, sharing ~/.claude's skills and hooks\nsideby login claude:work      # sign in once\nsideby run work               # Claude Code on the work account\nsideby ui                     # every account's quota at http://127.0.0.1:17420\n```\n\n`sideby run claude:main` keeps using `~/.claude` in another terminal at the same time. Arguments after `--` go to the Host: `sideby run work -- --resume`. To try it without installing, run `npx sideby`.\n\n## Set up with your AI agent\n\nPaste this into Claude Code, Codex or any coding agent:\n\n```text\nInstall the sideby CLI (npm package `sideby`) and its agent skill, then set up a second Claude Code account for me.\nFollow \"Set up sideby for a user\" in https://raw.githubusercontent.com/Adonis0123/sideby/main/llms.txt\n```\n\nThe agent checks Node and your Host CLIs, installs sideby and the skill, creates the account, tells you what it shares with your main one and makes its short command work. You sign in once in your browser; the agent gives you that one command. Once the skill is installed, short requests work too: \"add another Claude account, cc008\", \"what do my Codex accounts share?\", \"which account still has quota?\".\n\n## What it looks like\n\n<img alt=\"Two terminals: the personal account and the work account running at the same time, then the local quota panel\" src=\"https://raw.githubusercontent.com/Adonis0123/sideby/main/docs/assets/demo.gif\" width=\"1280\">\n\n<picture>\n  <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/Adonis0123/sideby/main/docs/assets/panel-dark.png\">\n  <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/Adonis0123/sideby/main/docs/assets/panel.png\">\n  <img alt=\"sideby panel: every account's 5h and 7d quota, 7-day token usage and health in one page\" src=\"https://raw.githubusercontent.com/Adonis0123/sideby/main/docs/assets/panel.png\" width=\"1280\">\n</picture>\n\n## What else it does\n\n| You want to | Run | Guide |\n|---|---|---|\n| Add an API key account (DeepSeek, a gateway, …) | `sideby new claude deepseek --api` | [API accounts](docs/guide/usage.md#api-accounts) |\n| Find and fix config drift between accounts | `sideby doctor --fix` | [Doctor](docs/guide/usage.md#doctor) |\n| See Claude quota (Codex needs no setup) | `sideby quota setup claude --yes` | [Claude quota](docs/guide/usage.md#claude-quota) |\n| Find the cheapest auto-compact size from your own sessions, and use it in one click | `sideby tune` (or the panel's Context tuning tab) | [Context tuning](docs/guide/usage.md#context-tuning) |\n| Move on when an account hits its limit | `sideby next claude` | [Handoff](docs/guide/usage.md#when-an-account-hits-its-limit) |\n| Let a running task move to the next account by itself when quota runs low (off by default; see the risk) | `sideby handoff enable` (or the panel) | [Auto Handoff](docs/guide/usage.md#auto-handoff) |\n| Short commands such as `ccw` | `sideby alias add ccw claude:work` | [Shell functions](docs/guide/configuration.md#shell-functions) |\n| Reopen a session from Orca and the like in the account that holds it | `\"resumeRouting\": true` in config | [Resuming from other tools](docs/guide/configuration.md#resuming-from-other-tools) |\n| Open the panel from the Dock or app menu | `sideby app install` | [Desktop app](docs/guide/panel.md#desktop-app) |\n| Show the panel inside your own local page | `createPanelHandler()` | [Embed the panel](docs/guide/panel.md#embed-the-panel) |\n| Add a Host or a pre-launch check | a local plugin | [Plugins](docs/guide/plugins.md) |\n\n## Supported hosts\n\n| Host | Account directories | Sign-in | Quota | Usage (7 days) |\n|---|---|---|---|---|\n| Claude Code | `~/.claude`, `~/.claude-<name>` | `claude auth login` | ✓ after `quota setup claude` | ✓ |\n| Codex CLI | `~/.codex`, `~/.codex-<name>` | `codex login` | ✓ | ✓ |\n| Grok Build | `~/.grok`, `~/.grok-<name>` | `grok login` | no public source | no public source |\n| pi | `~/.pi/agent`, `~/.pi-<name>/agent` | `/login` inside pi | no public source | no public source |\n\nsideby starts the official binary on your `PATH` and never patches it. Tested versions and per-Host notes are in the [guide](docs/guide/usage.md#host-notes).\n\n## Platforms\n\nmacOS and Linux. CI runs the suite on `ubuntu-latest` and `macos-latest`, Node 22 and 24. **Windows is untested.** `sideby app` only installs a launcher on macOS and Linux. Linked items are symlinks, `sideby shell-init` prints bash and zsh functions, and the Claude quota wrapper runs `/bin/sh`.\n\n## Roadmap\n\n**Gemini CLI.** Gemini can point at another config directory with `GEMINI_CONFIG_DIR`. Older docs use `GEMINI_CLI_HOME`; current builds treat that name as deprecated, and exit on startup if it is set together with an exact directory override. A sideby family still needs a tested Gemini version, a login check that does not read tokens, and a list of which files to link or copy. That is more than a small patch, so it is not in this version.\n\n## Safe by design\n\n- It never edits a Host's global config to switch accounts. It moves a task to another account only when you turn on Auto Handoff, and never proxies requests or pools logins.\n- It never reads, prints or sends a credential value. Nothing leaves your machine: sideby calls no remote service.\n- `doctor --fix` never replaces a real file and never changes where a link points.\n\nDetails and the terms-of-service question are in the [FAQ](docs/guide/faq.md).\n\nUsage questions and ideas go in [Discussions](https://github.com/Adonis0123/sideby/discussions).\n\n## Docs\n\n- [Using sideby](docs/guide/usage.md): accounts, API accounts, Doctor, quota, Handoff, Host notes\n- [Commands](docs/guide/commands.md): every command, exit codes and `--json`\n- [Configuration](docs/guide/configuration.md): `config.json`, aliases, shell functions\n- [Panel](docs/guide/panel.md): the panel, desktop app and embedding\n- [Plugins](docs/guide/plugins.md): write your own Family or launch hook\n- [FAQ](docs/guide/faq.md): terms of service, data locations, alternatives, uninstall\n- [Changelog](https://github.com/Adonis0123/sideby/releases)\n\n## For AI agents\n\n- [`llms.txt`](llms.txt): setup steps, commands, JSON contract and plugin API in one index. `sideby families --json` states what each Host's accounts share.\n- [`skills/sideby/SKILL.md`](skills/sideby/SKILL.md): one Agent Skill for seeing, repairing and creating accounts and for moving on when one hits its limit. Install with `npx skills add Adonis0123/sideby -g`; `sideby doctor` warns when the installed copy is for another sideby version.\n- [`AGENTS.md`](AGENTS.md): rules for agents working on this repository.\n\n## License\n\n[MIT](LICENSE)\n"
 }

package/schemas/config.json

@@ -153,6 +153,79 @@
       "type": "boolean",
       "description": "Make `sideby shell-init` also define Host-named functions (`claude`, `codex`, `grok`) that resume a session by id in the Account that holds it. Off by default."
     },
+    "handoff": {
+      "type": "object",
+      "properties": {
+        "auto": {
+          "type": "boolean",
+          "description": "Hand a running session to the next account when its Quota runs low: only to other families and API accounts unless `sameFamily` is on. Off by default."
+        },
+        "sameFamily": {
+          "type": "boolean",
+          "description": "Also hand off to an account of the same family (cc001 → cc002). The kind vendors are most likely to act on. Off by default."
+        },
+        "prepareAt": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100,
+          "description": "Quota Pressure at which the session starts keeping a Handoff Brief (default 80)."
+        },
+        "threshold": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100,
+          "description": "Quota Pressure at which the Handoff begins (default 95)."
+        },
+        "waitIfResetWithinMinutes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Stay and wait when the full window resets within this many minutes (default 30; 0 never waits)."
+        },
+        "countdownSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Countdown before the next account starts; Enter cancels (default 10; 0 skips it)."
+        },
+        "crossOrganization": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Accounts (ref or short command) that may take over from an account of another organization."
+        },
+        "families": {
+          "type": "object",
+          "patternProperties": {
+            "^.*$": {
+              "type": "object",
+              "properties": {
+                "policy": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "const": "pressure"
+                    },
+                    {
+                      "type": "string",
+                      "const": "order"
+                    }
+                  ]
+                },
+                "order": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "description": "Handoff Order per family the session starts in: `pressure` (default) or an `order` list."
+        }
+      },
+      "additionalProperties": false
+    },
     "shellInitFile": {
       "type": "object",
       "properties": {

package/schemas/families.json

@@ -23,7 +23,8 @@
               "bin",
               "installUrl",
               "installed",
-              "plugin"
+              "plugin",
+              "tuning"
             ],
             "properties": {
               "id": {
@@ -43,6 +44,9 @@
               },
               "plugin": {
                 "type": "string"
+              },
+              "tuning": {
+                "type": "boolean"
               }
             }
           },

package/schemas/handoff-disable.json

@@ -0,0 +1,106 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/handoff-disable.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "applied",
+    "file",
+    "diff",
+    "settings",
+    "nextSteps"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "applied": {
+      "type": "boolean"
+    },
+    "file": {
+      "type": "string"
+    },
+    "diff": {
+      "type": "string"
+    },
+    "settings": {
+      "type": "object",
+      "required": [
+        "auto",
+        "sameFamily",
+        "prepareAt",
+        "threshold",
+        "waitIfResetWithinMinutes",
+        "countdownSeconds",
+        "crossOrganization",
+        "families"
+      ],
+      "properties": {
+        "auto": {
+          "type": "boolean"
+        },
+        "sameFamily": {
+          "type": "boolean"
+        },
+        "prepareAt": {
+          "type": "number"
+        },
+        "threshold": {
+          "type": "number"
+        },
+        "waitIfResetWithinMinutes": {
+          "type": "number"
+        },
+        "countdownSeconds": {
+          "type": "number"
+        },
+        "crossOrganization": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "families": {
+          "type": "object",
+          "patternProperties": {
+            "^.*$": {
+              "type": "object",
+              "required": [
+                "policy",
+                "order"
+              ],
+              "properties": {
+                "policy": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "const": "pressure"
+                    },
+                    {
+                      "type": "string",
+                      "const": "order"
+                    }
+                  ]
+                },
+                "order": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "nextSteps": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "title": "sideby handoff disable --json"
+}

package/schemas/handoff-enable.json

@@ -0,0 +1,106 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/handoff-enable.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "applied",
+    "file",
+    "diff",
+    "settings",
+    "nextSteps"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "applied": {
+      "type": "boolean"
+    },
+    "file": {
+      "type": "string"
+    },
+    "diff": {
+      "type": "string"
+    },
+    "settings": {
+      "type": "object",
+      "required": [
+        "auto",
+        "sameFamily",
+        "prepareAt",
+        "threshold",
+        "waitIfResetWithinMinutes",
+        "countdownSeconds",
+        "crossOrganization",
+        "families"
+      ],
+      "properties": {
+        "auto": {
+          "type": "boolean"
+        },
+        "sameFamily": {
+          "type": "boolean"
+        },
+        "prepareAt": {
+          "type": "number"
+        },
+        "threshold": {
+          "type": "number"
+        },
+        "waitIfResetWithinMinutes": {
+          "type": "number"
+        },
+        "countdownSeconds": {
+          "type": "number"
+        },
+        "crossOrganization": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "families": {
+          "type": "object",
+          "patternProperties": {
+            "^.*$": {
+              "type": "object",
+              "required": [
+                "policy",
+                "order"
+              ],
+              "properties": {
+                "policy": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "const": "pressure"
+                    },
+                    {
+                      "type": "string",
+                      "const": "order"
+                    }
+                  ]
+                },
+                "order": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "nextSteps": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "title": "sideby handoff enable --json"
+}

package/schemas/handoff-ready.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/handoff-ready.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "requested"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "requested": {
+      "type": "boolean",
+      "const": true
+    },
+    "brief": {
+      "type": "string"
+    }
+  },
+  "title": "sideby handoff ready --json"
+}

package/schemas/handoff-setup.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/handoff-setup.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "family",
+    "applied",
+    "plan"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "family": {
+      "type": "string"
+    },
+    "applied": {
+      "type": "boolean"
+    },
+    "plan": {
+      "type": "object",
+      "required": [
+        "status",
+        "file",
+        "diff",
+        "message"
+      ],
+      "properties": {
+        "status": {
+          "anyOf": [
+            {
+              "type": "string",
+              "const": "enabled"
+            },
+            {
+              "type": "string",
+              "const": "ready"
+            },
+            {
+              "type": "string",
+              "const": "blocked"
+            }
+          ]
+        },
+        "file": {
+          "type": "string"
+        },
+        "diff": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "title": "sideby handoff setup --json"
+}

package/schemas/handoff-status.json

@@ -0,0 +1,137 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/handoff-status.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "auto",
+    "sameFamily",
+    "prepareAt",
+    "threshold",
+    "sideby",
+    "families",
+    "nextSteps"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "auto": {
+      "type": "boolean"
+    },
+    "sameFamily": {
+      "type": "boolean"
+    },
+    "prepareAt": {
+      "type": "number"
+    },
+    "threshold": {
+      "type": "number"
+    },
+    "sideby": {
+      "type": "object",
+      "required": [
+        "ok"
+      ],
+      "properties": {
+        "ok": {
+          "type": "boolean"
+        },
+        "problem": {
+          "type": "string"
+        }
+      }
+    },
+    "families": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "family",
+          "starts",
+          "ready",
+          "problems",
+          "notes",
+          "order"
+        ],
+        "properties": {
+          "family": {
+            "type": "string"
+          },
+          "starts": {
+            "type": "array",
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "const": "quota"
+                },
+                {
+                  "type": "string",
+                  "const": "limit"
+                }
+              ]
+            }
+          },
+          "ready": {
+            "type": "boolean"
+          },
+          "problems": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "notes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "order": {
+            "type": "object",
+            "required": [
+              "policy",
+              "order",
+              "unknown"
+            ],
+            "properties": {
+              "policy": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "const": "pressure"
+                  },
+                  {
+                    "type": "string",
+                    "const": "order"
+                  }
+                ]
+              },
+              "order": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "unknown": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "nextSteps": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "title": "sideby handoff status --json"
+}

package/schemas/handoff-teardown.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sideby/handoff-teardown.json",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "family",
+    "ok",
+    "message"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "number",
+      "const": 1
+    },
+    "family": {
+      "type": "string"
+    },
+    "ok": {
+      "type": "boolean"
+    },
+    "message": {
+      "type": "string"
+    },
+    "diff": {
+      "type": "string"
+    }
+  },
+  "title": "sideby handoff teardown --json"
+}

package/schemas/list.json

@@ -23,7 +23,8 @@
           "bin",
           "installUrl",
           "installed",
-          "plugin"
+          "plugin",
+          "tuning"
         ],
         "properties": {
           "id": {
@@ -43,6 +44,9 @@
           },
           "plugin": {
             "type": "string"
+          },
+          "tuning": {
+            "type": "boolean"
           }
         }
       }