sideby 0.13.0 → 0.14.0

package/dist/src/panel/page-styles.js

@@ -177,13 +177,29 @@ code, .mono { font-family: var(--mono); font-size: 0.92em; }
 .row:first-child { border-top: 0; }
 .row:last-child { border-radius: 0 0 var(--radius) var(--radius); }
 .row-error .ident-name .name { color: var(--fail); }
-/* A login group (spec §3.21): the head carries the email and the one quota; the directories sit indented under it. */
-.login { border-top: 1px solid var(--border); }
+/* A login group (spec §3.21): ordinary rows that share one quota, tied together by a rail on the left. */
+.login { position: relative; border-top: 1px solid var(--border); }
 .login:first-child { border-top: 0; }
-.rows .login > .login-head { border-top: 0; padding-bottom: 4px; }
-.rows .login > .login-head:hover { background: transparent; }
-.login-rows > .row, .login-rows > .row:first-child { border-top: 1px dashed var(--border); padding-left: 40px; }
+.login::before { content: ""; position: absolute; left: 5px; top: 12px; bottom: 12px; width: 3px; border-radius: 3px; background: var(--border-strong); }
+.login-rows > .row:first-child { border-top: 0; }
+.login-rows > .row + .row { border-top: 1px dashed var(--border); }
 .login-rows > .row:last-child { border-radius: 0 0 var(--radius) var(--radius); }
+.q-shared { gap: 6px; color: var(--faint); }
+.q-shared .ic { width: 13px; height: 13px; }
+/* Display Order (spec §3.25): a grip at the start of a group head or row, shown on hover or focus, always on touch
+   screens. A row's grip sits in its left padding, so the row's layout is the same with or without it. */
+.row { position: relative; }
+.drag-handle { width: 16px; height: 28px; color: var(--faint); cursor: grab; opacity: 0; transition: opacity .12s; }
+.drag-handle .ic { width: 14px; height: 14px; }
+.drag-handle:active { cursor: grabbing; }
+.row > .ident > .drag-handle { position: absolute; left: 0; top: 13px; }
+.group-head > .drag-handle { margin-right: -8px; }
+.group-head:hover > .drag-handle, .row:hover > .ident > .drag-handle, .drag-handle:focus-visible { opacity: 1; }
+@media (hover: none) { .drag-handle { opacity: 1; } }
+.is-dragging { opacity: .45; }
+.drop-before { box-shadow: inset 0 2px 0 var(--accent); }
+.drop-after { box-shadow: inset 0 -2px 0 var(--accent); }
+.tb-reset[hidden] { display: none; }
 /* The arrow at a row's start opens and closes its details; so does a click anywhere else in the row. */
 .row-toggle { width: 28px; height: 28px; margin: -4px -6px -4px -8px; }
 .fold-hit { cursor: pointer; }
@@ -245,7 +261,9 @@ code, .mono { font-family: var(--mono); font-size: 0.92em; }
 .m-pct { font-weight: var(--strong-weight); font-size: 13px; font-variant-numeric: tabular-nums; }
 .m-unit { color: var(--faint); font-weight: 400; font-size: 11.5px; }
 .m-reset { margin-left: auto; color: var(--faint); font-size: 11.5px; font-variant-numeric: tabular-nums; overflow: hidden; text-overflow: ellipsis; }
-.m-passed { font-style: italic; }
+.m-passed { color: var(--muted); }
+.m-asof { display: inline-flex; margin-left: 4px; color: var(--faint); vertical-align: -1px; }
+.m-asof .ic { width: 12px; height: 12px; }
 .m-none { color: var(--faint); }
 .bar { height: 6px; border-radius: 999px; background: var(--track); overflow: hidden; margin-top: 5px; }
 .bar > span { display: block; height: 100%; min-width: 0; border-radius: inherit; background: var(--ok-bar); transition: width .4s ease; }
@@ -253,9 +271,9 @@ code, .mono { font-family: var(--mono); font-size: 0.92em; }
 .lvl-fail .bar > span { background: var(--fail-bar); } .lvl-fail .m-pct { color: var(--fail); }
 .lvl-reset .m-pct { color: var(--muted); }
 .lvl-stale.lvl-ok .m-pct { color: var(--muted); }
-.is-stale .bar > span, .lvl-stale .bar > span { background: var(--faint); opacity: .5; }
-.q-asof { grid-column: 1 / -1; display: flex; align-items: center; gap: 4px; color: var(--faint); font-size: 11.5px; line-height: 1.3; }
-.q-asof .ic { width: 12px; height: 12px; }
+/* Old numbers keep their level's color, paler, so the bar and the number agree. */
+.lvl-stale .bar > span { opacity: .45; }
+.lvl-stale.lvl-ok .bar > span { background: var(--faint); }
 .q-note { grid-column: 1 / -1; display: flex; align-items: center; gap: 8px; flex-wrap: wrap; color: var(--muted); font-size: var(--small); }
 .link-btn { padding: 0; border: 0; background: none; color: var(--accent); font: inherit; font-weight: var(--strong-weight); cursor: pointer; }
 .link-btn:hover:not(:disabled) { text-decoration: underline; }
@@ -541,6 +559,9 @@ select:is(:hover, :focus) { --chevron: var(--text); }
 .set-row { display: flex; align-items: center; justify-content: space-between; gap: 12px; }
 .set-label { color: var(--muted); font-size: 13px; white-space: nowrap; }
 .set-row .seg { height: var(--ctl-h-sm); }
+.set-check { align-items: flex-start; }
+.set-text { display: flex; flex-direction: column; gap: 2px; min-width: 0; }
+.set-hint { color: var(--faint); font-size: 12px; max-width: 260px; }
 .set-link { margin: 0 -8px; width: calc(100% + 16px); }
 .set-link .chip { margin-left: auto; }
 .set-dot { background: var(--warn-bar); }
@@ -599,7 +620,6 @@ select:is(:hover, :focus) { --chevron: var(--text); }
   .app-actions { width: 100%; justify-content: flex-start; }
   .row { grid-template-columns: minmax(0, 1fr) auto var(--m-w); grid-template-areas: "id last more" "quota quota quota" "detail detail detail" "notes notes notes"; row-gap: 10px; }
   .row-detail { margin-left: 0; }
-  .login-rows > .row, .login-rows > .row:first-child { padding-left: 28px; }
   .row > .quota { grid-template-columns: repeat(var(--qn), minmax(0, 1fr)); max-width: 560px; }
   .rows .m-label, .rows .m-unit, .rows .u-unit { display: inline; }
   .rows .usage { justify-content: flex-start; }

package/dist/src/runtime.d.ts

@@ -1,5 +1,5 @@
 import { type AccountRefError } from './core/accounts.ts';
-import { type Config, type HandoffSettings } from './core/config.ts';
+import { type Config, type DisplayConfig, type HandoffSettings } from './core/config.ts';
 import { type CreateResult } from './core/create.ts';
 import { type DesktopDeps } from './core/desktop-app.ts';
 import { type DoctorReport } from './core/doctor.ts';
@@ -9,6 +9,7 @@ import { type HandoffDecision } from './core/handoff-select.ts';
 import { type DoctorHistory } from './core/last-doctor.ts';
 import { type HostLaunch, type PreparedLaunch } from './core/launch.ts';
 import { type Paths } from './core/paths.ts';
+import { type QuotaFetchMode } from './core/quota-fetch.ts';
 import { type RemoteControlChange, type RemoteControlGroup } from './core/remote-control.ts';
 import { type Shell, type ShellInitWrite } from './core/shell-init.ts';
 import { type TuneEntry, type TuneGroup } from './core/tuning.ts';
@@ -209,7 +210,24 @@ export interface Runtime {
      * The Account's Quota. For an Account of a Same Login (spec §3.21) it is the group's freshest reading, with `from`
      * naming the Account it was read from when that is another one.
      */
-    quota(account: Account): Promise<QuotaResult>;
+    quota(account: Account, opts?: {
+        fetch?: QuotaFetchMode;
+    }): Promise<QuotaResult>;
+    /**
+     * Asks every Family that fetches Quota (spec §3.26) again now, for `only` or every signed-in subscription Account,
+     * and waits for the answers. Fetching that is turned off stays off.
+     */
+    refreshQuota(only?: readonly Account[]): Promise<void>;
+    /** Families that fetch Quota, with their switch (config `quota.check.<family>`) and why it is off, if it is. */
+    quotaChecks(): QuotaCheckInfo[];
+    /** Turns a Family's Quota fetching on (removes the key) or off (`quota.check.<family>: false`). */
+    setQuotaCheck(family: string, on: boolean): Promise<{
+        changed: boolean;
+    }>;
+    /** The config `display` (spec §3.25), or an empty object. */
+    displayOrder(): DisplayConfig;
+    /** Replaces the config `display`; undefined or empty removes it. Returns what the file now holds. */
+    setDisplayOrder(display: DisplayConfig | undefined): Promise<DisplayConfig>;
     /** The other Accounts signed in as the same login as this one (spec §3.21), in discovery order; empty when none. */
     sameLogin(account: Account): Promise<string[]>;
     usage(account: Account): Promise<UsageResult>;
@@ -263,6 +281,16 @@ export interface Runtime {
 }
 export declare class UnknownFamilyError extends UserError {
 }
+export interface QuotaCheckInfo {
+    family: string;
+    title: string;
+    summary: string;
+    everyMinutes: number;
+    /** False when config `quota.check.<family>` is false. */
+    on: boolean;
+    /** Why no fetch happens even though it is on (CI), or undefined. */
+    blocked?: string;
+}
 export declare function createRuntime(opts?: {
     env?: Env;
     builtins?: BuiltinPlugin[];

package/dist/src/runtime.js

@@ -1,6 +1,6 @@
 // The one service layer the CLI and the Panel share. Frozen contract for v0.1 (plan: 审核修订).
 import { aliasesByAccount, discoverAccounts, resolveRef } from './core/accounts.js';
-import { addConfigAlias, aliasAccount, aliasArgs, aliasProblem, aliasRefs, handoffSettings, loadConfig, removeConfigAlias, } from './core/config.js';
+import { addConfigAlias, aliasAccount, aliasArgs, aliasProblem, aliasRefs, editConfigDisplay, editConfigQuotaCheck, handoffSettings, loadConfig, removeConfigAlias, } from './core/config.js';
 import { createAccount } from './core/create.js';
 import { bindDesktopDeps, checkAppData } from './core/desktop-app.js';
 import { applyFixes, runDoctor } from './core/doctor.js';
@@ -10,9 +10,10 @@ import { handoffFindings } from './core/handoff-doctor.js';
 import { selectNext } from './core/handoff-select.js';
 import { identityOf } from './core/identity.js';
 import { mergeDoctorHistory, readDoctorHistory, writeDoctorHistory, } from './core/last-doctor.js';
-import { brokenOnPath, prepareLaunch, which } from './core/launch.js';
+import { accountEnv, brokenOnPath, prepareLaunch, which, } from './core/launch.js';
 import { memoStore } from './core/memo-store.js';
 import { resolvePaths } from './core/paths.js';
+import { fetchedQuota, quotaCheckOff, shownQuota } from './core/quota-fetch.js';
 import { remoteControlGroups, turnRemoteControlOff, turnRemoteControlOn, undoRemoteControlOff, } from './core/remote-control.js';
 import { findResumeRoute } from './core/resume.js';
 import { SAME_LOGIN_FAMILIES, sameLoginGroups, sharedQuota } from './core/same-login.js';
@@ -106,31 +107,43 @@ export async function createRuntime(opts = {}) {
         return list.filter((a) => peers.includes(a.ref));
     };
     /** Every Account's Quota as shown (shared within a Same Login), reading each Account's own cache once. */
-    const quotasOf = async (list) => {
+    const quotasOf = async (list, mode = 'wait') => {
         const [own, groups] = await Promise.all([
-            Promise.all(list.map(async (a) => [a.ref, await ownQuota(a)])).then((e) => new Map(e)),
+            Promise.all(list.map(async (a) => [a.ref, await ownQuota(a, mode)])).then((e) => new Map(e)),
             groupsOf(list),
         ]);
         return new Map(list.map((a) => [a.ref, sharedQuota(a.ref, own, groups.get(a.ref) ?? [])]));
     };
-    const ownQuota = async (account) => {
+    /** A reader's own `from`, `fetched` and `fetchError` are dropped: only sideby sets them (spec §3.21, §3.26). */
+    const readerOnly = (q) => {
+        if (q.status !== 'ok')
+            return q;
+        const { from: _from, fetched: _fetched, fetchError: _error, ...own } = q;
+        return own;
+    };
+    const ownQuota = async (account, mode = 'wait') => {
         if (account.kind === 'api')
             return { status: 'unavailable', reason: 'api-account' };
         const f = familyOf(account.family);
-        if (!f.readQuota)
+        if (!f.readQuota && !f.fetchQuota)
             return { status: 'unavailable', reason: 'no-source' };
         await memos.ready();
         try {
-            const q = await f.readQuota(account, readContext());
-            // Only sideby marks a reading as borrowed from another Account (spec §3.21); a reader's own `from` is dropped.
-            if (q.status === 'ok' && q.from !== undefined) {
-                const { from: _from, ...own } = q;
-                return own;
-            }
-            return q;
-        }
-        catch (err) {
-            return { status: 'unavailable', reason: 'unrecognized', detail: err.message };
+            let local = null;
+            if (f.readQuota)
+                try {
+                    local = readerOnly(await f.readQuota(account, readContext()));
+                }
+                catch (err) {
+                    local = { status: 'unavailable', reason: 'unrecognized', detail: err.message };
+                }
+            if (!f.fetchQuota)
+                return local;
+            const off = quotaCheckOff(f.id, config, env);
+            // A signed-out Account has nothing to ask about; its kept answer still shows.
+            const ask = off || mode === 'never' || (await loginOf(account)) === 'logged-out' ? 'never' : mode;
+            const kept = await fetchedQuota(f.fetchQuota, account, readContext(), accountEnv(f, account, env), ask);
+            return shownQuota(local, kept, off);
         }
         finally {
             memos.saveSoon();
@@ -233,7 +246,7 @@ export async function createRuntime(opts = {}) {
                     layout: { main: f.layout.main, account: f.layout.account },
                     selectVar: f.selectVar,
                     login: { args: f.login.args ? [...f.login.args] : null, hint: f.login.hint },
-                    quota: Boolean(f.readQuota),
+                    quota: Boolean(f.readQuota || f.fetchQuota),
                     usage: Boolean(f.readUsage),
                     quotaSetup: Boolean(f.quotaSetup),
                     shared: f.sharedItems.map((item) => ({
@@ -497,11 +510,41 @@ export async function createRuntime(opts = {}) {
                 account: route.account,
             };
         },
-        async quota(account) {
+        async quota(account, o = {}) {
             const peers = await peersOf(account);
             if (!peers.length)
-                return ownQuota(account);
-            return (await quotasOf([account, ...peers])).get(account.ref);
+                return ownQuota(account, o.fetch);
+            return (await quotasOf([account, ...peers], o.fetch)).get(account.ref);
+        },
+        async refreshQuota(only) {
+            const list = (only ?? (await accounts())).filter((a) => a.kind === 'subscription' && families.get(a.family)?.fetchQuota);
+            await Promise.all(list.map((a) => ownQuota(a, 'force')));
+        },
+        quotaChecks() {
+            const ci = quotaCheckOff('', {}, env);
+            return [...families.values()]
+                .filter((f) => f.fetchQuota)
+                .map((f) => ({
+                family: f.id,
+                title: f.title,
+                summary: f.fetchQuota.summary,
+                everyMinutes: f.fetchQuota.everyMinutes,
+                on: config.quota?.check?.[f.id] !== false,
+                ...(ci ? { blocked: ci } : {}),
+            }));
+        },
+        async setQuotaCheck(family, on) {
+            if (!families.get(family)?.fetchQuota)
+                throw new UserError(`${family} does not ask for quota, so there is nothing to turn on or off`);
+            const r = await editConfigQuotaCheck(paths.configFile, family, on);
+            config.quota = r.after;
+            return { changed: r.changed };
+        },
+        displayOrder: () => config.display ?? {},
+        async setDisplayOrder(display) {
+            const r = await editConfigDisplay(paths.configFile, display);
+            config.display = r.after;
+            return r.after ?? {};
         },
         async sameLogin(account) {
             return (await peersOf(account)).map((a) => a.ref);
@@ -616,7 +659,7 @@ export async function createRuntime(opts = {}) {
         async handoff(familyId, o = {}) {
             const f = familyOf(familyId);
             const list = (await accounts()).filter((a) => a.family === f.id);
-            if (!f.readQuota)
+            if (!f.readQuota && !f.fetchQuota)
                 throw new UserError(`${f.title} has no public quota source, so sideby cannot tell which account has room; pick one yourself: ${list.map((a) => `sideby run ${a.ref}`).join(', ') || `sideby new ${f.id} <name>`}`, { code: 'no-quota-source' });
             if (list.length === 0)
                 throw new UserError(`no ${f.title} accounts yet; create one with \`sideby new ${f.id} <name>\``, {

package/dist/src/types.d.ts

@@ -87,7 +87,13 @@ export interface FamilyDef {
      * error is treated the same way and never shown as a problem.
      */
     identity?(account: Account): Promise<AccountIdentity | undefined>;
+    /** Quota from local files only; read every time sideby shows Quota. */
     readQuota?(account: Account, ctx: ReadContext): Promise<QuotaResult>;
+    /**
+     * Quota that costs a request, such as asking the Host's own CLI (spec §3.26, ADR-0025). sideby decides when to call
+     * it and keeps its last answer; the newer of that answer and `readQuota`'s is shown.
+     */
+    fetchQuota?: QuotaFetch;
     readUsage?(account: Account, ctx: ReadContext): Promise<UsageResult>;
     /**
      * Estimates the best Compaction Threshold per model from the Account's recent local session records
@@ -185,6 +191,12 @@ export interface QuotaSetup {
         message: string;
         diff?: string;
     }>;
+    /**
+     * For a setup that adds a whole file: earlier versions of that file, byte for byte, which an older sideby wrote.
+     * Setup replaces such a file after a preview, teardown removes it, and the Panel's copies into other Accounts
+     * replace it; a file with any other content is never touched.
+     */
+    earlierTexts?: readonly string[];
 }
 export interface Account {
     family: string;
@@ -206,15 +218,47 @@ export interface ReadContext {
     /** sideby's own environment (PATH lookups); never the Host's. */
     env: Env;
 }
+/**
+ * How sideby asks for a Family's Quota when that costs a request (spec §3.26). sideby keeps each Account's last
+ * answer in its state directory and calls `fetch` at most every `everyMinutes`, or when the user refreshes; never
+ * from the status line or the handoff hook, for an API Account or a signed-out one, in CI, or when the user turned it
+ * off (config `quota.check.<family>: false`).
+ */
+export interface QuotaFetch {
+    /** At most one `fetch` per Account in this many minutes, unless the user refreshes. */
+    everyMinutes: number;
+    /** What a fetch does, in one plain sentence, shown next to the setting that turns it off. */
+    summary: string;
+    /**
+     * The Account's Quota now. An error, or an `unavailable` result, keeps the last good answer on show. Stop when
+     * `ctx.signal` aborts (after 20 seconds).
+     */
+    fetch(account: Account, ctx: QuotaFetchContext): Promise<QuotaResult>;
+}
+export interface QuotaFetchContext extends ReadContext {
+    signal: AbortSignal;
+    /**
+     * The environment the Host gets at Launch, before the Secret File and Plugin hooks: sideby's own, Hijack Variables
+     * cleared, the Family's `selectVar` set for every Account but the Main Account. Run the Host with this one.
+     */
+    hostEnv: Env;
+}
 export interface QuotaWindow {
     /** `5h`, `7d`, or `<n>m` for unknown window lengths. */
     label: string;
+    /**
+     * The group of models this limit covers, such as Cursor's "Other models", when it covers only some of them. Such a
+     * window is shown under this name but never counts toward Quota Pressure: the Account can still use other models.
+     */
+    name?: string;
     windowMinutes: number;
     usedPercent: number;
     /** ISO timestamp. */
     resetsAt: string;
 }
-export type QuotaUnavailableReason = 'not-enabled' | 'no-session' | 'unrecognized' | 'no-source' | 'api-account';
+export type QuotaUnavailableReason = 'not-enabled' | 'no-session' | 'unrecognized' | 'no-source' | 'api-account'
+/** A `fetchQuota` answer failed; `detail` says why and what to do. */
+ | 'fetch-failed';
 export type QuotaResult = {
     status: 'ok';
     windows: QuotaWindow[];
@@ -226,6 +270,10 @@ export type QuotaResult = {
      * Account signed in as the same login (spec §3.21). `observedAt` is that Account's time.
      */
     from?: string;
+    /** Set by sideby: this reading is the kept answer of the Family's `fetchQuota`, not of its local reader. */
+    fetched?: boolean;
+    /** Set by sideby: why the latest `fetchQuota` attempt failed, while this older reading stays on show. */
+    fetchError?: string;
 } | {
     status: 'unavailable';
     reason: QuotaUnavailableReason;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sideby",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "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)",
@@ -79,5 +79,5 @@
   },
   "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## 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 quota setup claude --yes  # Claude quota in the panel; undo: sideby quota teardown claude\nsideby ui                        # every account's quota at http://127.0.0.1:17420\n```\n\n`sideby update` installs a newer sideby when there is one; sideby says so after a command and in the panel. `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\nThe 25-second story: one account buried in tasks, then accounts side by side sharing one setup, and a task moving on when one runs out.\n\nhttps://github.com/user-attachments/assets/3a470c03-9009-4f1d-b7f6-8b4625d74958\n\n<img alt=\"Two terminals: the personal account and the work account running at the same time, both linked to the main account's skills and settings, then the local quota panel, and at 95% Auto Handoff moving work's session to the next account\" 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## 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## 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| See each account's model and effort, and set them per account | `sideby model <account>` (or click the model in the panel) | [Model and effort](docs/guide/usage.md#model-and-effort) |\n| Choose whether Claude sessions connect to claude.ai by themselves (Remote Control), for every account at once | `sideby remote-control off` or `on` (or the panel's Settings) | [Remote Control](docs/guide/usage.md#remote-control) |\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 Claude Desktop or the Codex app as one account, several side by side (macOS) | `sideby desktop claude:work` (or the panel) | [Desktop apps](docs/guide/usage.md#desktop-apps) |\n| Keep several Grok Bot windows open, each signed in to its own account (macOS) | `sideby desktop grok-bot:002` (or the panel) | [Grok Bot windows](docs/guide/usage.md#grok-bot-windows) |\n| Open the panel from the Dock or app menu | `sideby app install` | [Panel app](docs/guide/panel.md#panel-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 about your accounts leaves your machine: the only request sideby makes on its own is a daily check of the npm registry for its newest version (off with `NO_UPDATE_NOTIFIER=1`; see [Updates](docs/guide/configuration.md#updates)).\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, panel 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"
+  "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## 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 quota setup claude --yes  # Claude quota in the panel; undo: sideby quota teardown claude\nsideby ui                        # every account's quota at http://127.0.0.1:17420\n```\n\n`sideby update` installs a newer sideby when there is one; sideby says so after a command and in the panel. `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\nThe 25-second story: one account buried in tasks, then accounts side by side sharing one setup, and a task moving on when one runs out.\n\nhttps://github.com/user-attachments/assets/3a470c03-9009-4f1d-b7f6-8b4625d74958\n\n<img alt=\"Two terminals: the personal account and the work account running at the same time, both linked to the main account's skills and settings, then the local quota panel, and at 95% Auto Handoff moving work's session to the next account\" 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## 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## 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| See each account's model and effort, and set them per account | `sideby model <account>` (or click the model in the panel) | [Model and effort](docs/guide/usage.md#model-and-effort) |\n| Choose whether Claude sessions connect to claude.ai by themselves (Remote Control), for every account at once | `sideby remote-control off` or `on` (or the panel's Settings) | [Remote Control](docs/guide/usage.md#remote-control) |\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 Claude Desktop or the Codex app as one account, several side by side (macOS) | `sideby desktop claude:work` (or the panel) | [Desktop apps](docs/guide/usage.md#desktop-apps) |\n| Keep several Grok Bot windows open, each signed in to its own account (macOS) | `sideby desktop grok-bot:002` (or the panel) | [Grok Bot windows](docs/guide/usage.md#grok-bot-windows) |\n| Open the panel from the Dock or app menu | `sideby app install` | [Panel app](docs/guide/panel.md#panel-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` | weekly, asked from the `grok` CLI | 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 about your accounts leaves your machine: the only request sideby makes on its own is a daily check of the npm registry for its newest version (off with `NO_UPDATE_NOTIFIER=1`; see [Updates](docs/guide/configuration.md#updates)).\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, panel 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/alias.json

@@ -96,6 +96,68 @@
         }
       },
       "description": "One entry per config `shellInitFile`, rewritten after the change."
+    },
+    "_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": "Updates the installed sideby skill (run it after the user agrees)."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "description": "Not the answer to the task: mention it briefly afterwards and offer to update."
     }
   },
   "title": "sideby alias add|rm --json"

package/schemas/app-install.json

@@ -68,6 +68,68 @@
       "items": {
         "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": "Updates the installed sideby skill (run it after the user agrees)."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "description": "Not the answer to the task: mention it briefly afterwards and offer to update."
     }
   },
   "title": "sideby app install --json"

package/schemas/app-uninstall.json

@@ -48,6 +48,68 @@
           }
         }
       }
+    },
+    "_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": "Updates the installed sideby skill (run it after the user agrees)."
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "description": "Not the answer to the task: mention it briefly afterwards and offer to update."
     }
   },
   "title": "sideby app uninstall --json"