@voidlabs.gg/voidshift-agents 0.0.0-stage → 0.4.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,137 @@
-# Temporary Holding Version
+# VoidShift
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+One CLI for the Void dev tools. Install it once, run `vsf` (short for
+`voidshift`), pick the tools you want, and it sets each one up with good
+defaults you can change. Everything setup does can be seen and changed later
+from the command line.
+
+> Early release. macOS only for now; Windows and Linux are next.
+
+```sh
+npm i -g @voidlabs.gg/voidshift
+vsf setup              # pick tools and set them up
+vsf setup --defaults   # take every default, ask only what has none
+vsf                    # what every tool is doing (first run: setup)
+vsf help               # every command; vsf <tool> help for a tool's
+```
+
+## Tools
+
+| Tool | What it does |
+|---|---|
+| `awake` | Keeps your Mac running, on battery and with the lid closed, and puts sleep back when the battery runs low, the Mac gets hot, a timer ends or it restarts |
+| `agents` | Agents for Claude Code and Codex, and workflows that run them in the background off your Linear cards |
+| `memory` | A markdown vault of notes, recalled into Claude Code and Codex before every prompt |
+
+### awake
+
+```sh
+vsf awake on [--until 7am | --for 6h] [--battery 20]
+vsf awake status
+vsf awake logs [-f]     # what the watchdog decided
+vsf awake off
+```
+
+Setup asks for your Mac password once to add a rule that allows only
+`pmset -a disablesleep 0|1`. A small watchdog checks every minute and turns
+sleep back on when it should. Keep a closed Mac out of a bag: with no airflow
+it runs hot.
+
+### agents
+
+Five agents, installed into Claude Code (and Codex if you use it):
+
+| Agent | What it does |
+|---|---|
+| Plan | plans a Linear card against the code |
+| Plan review | checks a plan before it is published |
+| Publish | posts the plan to the card and hands it over |
+| Dev | implements the plan and opens a draft PR |
+| QA | CI, then code review, then a usability check in a headless browser |
+
+Use them yourself (`/vs-plan ENG-123` in Claude Code), or let a **workflow**
+run them. A workflow starts when one of your Linear cards gets a label, runs
+agents in order in a project (a repo on your Mac), and sends work back to the
+step that made it when a check fails:
+
+```
+when ENG + vs-plan:  Dev → QA  in tether-relay
+```
+
+The runner checks Linear every minute, works in its own copy of the repo so
+your checkout is never touched, and keeps two labels on the card as it goes: the
+stage (`vs-planning`, `vs-plan-review`, `vs-dev`, `vs-qa`, then `vs-qa-verified`
+or `vs-parked`) and the round (`vs-v1`, `vs-v2`). On Linear it posts the plan and
+one final comment, nothing in between.
+
+```sh
+vsf agents status                  # runner, the card in progress, parked cards
+vsf agents run ENG-123 [--from qa] # run one card now, in this terminal
+vsf agents start | stop | restart  # the background runner (stop cancels the card)
+vsf agents pause | resume          # pick up no new cards for a while
+vsf agents cancel | retry ENG-123  # stop a card, or queue a parked one again
+vsf agents runs | show ENG-123     # what happened, step by step
+vsf agents logs [ENG-123] [-f]     # the runner log, or a card's step logs
+vsf agents workflows               # workflows in the order they match
+vsf agents workflow add|edit|show|rename|move|rm
+vsf agents projects | project add|edit|show|rename|rm
+vsf agents homes | link DIR        # where the agents are installed
+vsf agents clean                   # old worktrees and run logs
+```
+
+### memory
+
+A folder of markdown notes, one topic per note, with an `INDEX.md` holding one
+keyword line per note. Before every prompt, the words you type are matched
+against the index and the best notes are handed to Claude Code or Codex. A
+`memory` skill tells them how to read the vault and when to write a note:
+decisions and their why, dead ends, things that are not obvious from the code.
+Background agents read it for each card and save what they learn.
+
+```sh
+vsf memory status          # the vault and where recall is on
+vsf memory search WORDS    # notes recall would bring up
+vsf memory try "a prompt"  # exactly what recall would add to that prompt
+vsf memory check           # notes missing from INDEX.md, broken links
+vsf memory on | off        # turn recall on or off
+```
+
+Setup creates a vault at `~/memory` or uses one you already have. Codex asks you
+to trust the recall hook once: run `/hooks` in Codex.
+
+## What to know
+
+- **Your own logins.** Agents run the official `claude` and `codex` CLIs you
+  already use, signed in with your own account. VoidShift never reads or
+  stores those credentials. The Linear API key for the runner lives in your
+  macOS Keychain.
+- **Trust.** The Dev agent can run shell commands inside its copy of the repo
+  so it can install and test. Review its pull requests like any other.
+- **Your config** lives in `~/.config/voidshift`.
+
+```sh
+vsf doctor                     # check everything is set up, and whether an update is out
+vsf config [tool]              # every saved setting
+vsf config set KEY VALUE       # e.g. vsf config set agents.models.dev opus
+vsf config edit [tool]         # edit settings in $EDITOR, checked before saving
+vsf update                     # update VoidShift and every tool you added
+vsf tools                      # list tools
+
+Read commands take `--json`. Workflow and project names can be shortened to
+any unique start, e.g. `tether` for `tether-relay-build`.
+```
+
+## Development
+
+```sh
+pnpm install
+pnpm test
+node packages/cli/src/main.ts
+```
+
+Node 22.18 or newer runs the TypeScript sources directly. Releases are cut by
+pushing a `v*` tag; CI publishes every package at that version.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/dist/config.d.ts

@@ -0,0 +1,60 @@
+import type { Engine } from './engine.ts';
+export type StepId = 'vs-plan' | 'vs-plan-review' | 'vs-publish' | 'vs-dev' | 'vs-qa';
+export type Output = 'plan' | 'verdict' | 'commits' | 'publish';
+export declare const STEPS: Record<StepId, {
+    label: string;
+    output: Output;
+    hint: string;
+}>;
+export declare const isProducer: (s: StepId) => boolean;
+export declare const AGENTS: Record<string, {
+    label: string;
+    hint: string;
+}>;
+export declare const visibleAgents: () => string[];
+export declare const stepEnabled: (step: StepId, enabled: string[]) => boolean;
+export interface Trigger {
+    source: 'linear';
+    team: string;
+    label: string;
+}
+export interface Project {
+    path: string;
+    base?: string;
+}
+export interface Workflow {
+    triggers: Trigger[];
+    steps: StepId[];
+    maxRounds: number;
+    project: string;
+}
+export interface AgentsConfig {
+    engine: Engine;
+    models: {
+        dev?: string;
+        review?: string;
+    };
+    projects: Record<string, Project>;
+    workflows: Record<string, Workflow>;
+    reviewState: string;
+    timeoutMinutes: number;
+    homes: {
+        kind: 'claude' | 'codex';
+        dir: string;
+    }[];
+    enabled: string[];
+}
+export declare const TEMPLATES: Record<string, {
+    steps: StepId[];
+    maxRounds: number;
+}>;
+export declare const DEFAULTS: AgentsConfig;
+export declare const agentsDir: (configDir: string) => string;
+export declare const hasWork: (workflow: Pick<Workflow, "steps">) => boolean;
+export declare const hasProducer: (workflow: Pick<Workflow, "steps">) => boolean;
+export declare const describeSteps: (steps: StepId[]) => string;
+export declare const describeTriggers: (triggers: Trigger[]) => string;
+export declare const describeWorkflow: (c: Workflow) => string;
+export declare function migrate(saved: Record<string, any>): Partial<AgentsConfig>;
+export declare function readAgentsConfig(configDir: string): AgentsConfig;
+export declare function writeAgentsConfig(configDir: string, config: AgentsConfig): void;

package/dist/config.js

@@ -0,0 +1,98 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { basename, join } from 'node:path';
+export const STEPS = {
+    'vs-plan': { label: 'Plan', output: 'plan', hint: 'writes a plan and posts it to the card' },
+    'vs-plan-review': { label: 'Plan review', output: 'verdict', hint: 'checks the plan; on FIX the workflow goes back to Plan' },
+    'vs-publish': { label: 'Publish', output: 'publish', hint: 'creates and pushes the branch for the card' },
+    'vs-dev': { label: 'Dev', output: 'commits', hint: 'implements the plan, commits, opens a draft PR' },
+    'vs-qa': { label: 'QA', output: 'verdict', hint: 'CI, then code review, then a usability check; on FIX back to Dev' },
+};
+// Steps a failed verdict can send work back to.
+export const isProducer = (s) => STEPS[s].output === 'plan' || STEPS[s].output === 'commits';
+// The agents in the pack, as setup describes them.
+export const AGENTS = {
+    'vs-plan': { label: 'Plan', hint: 'plans a card against the code' },
+    'vs-plan-review': { label: 'Plan review', hint: 'checks a plan before it is published' },
+    'vs-publish': { label: 'Publish', hint: 'posts the plan to Linear and hands the card over' },
+    'vs-dev': { label: 'Dev', hint: 'implements the plan and opens a draft PR' },
+    'vs-qa': { label: 'QA', hint: 'CI, then code review, then a usability check' },
+};
+export const visibleAgents = () => Object.keys(AGENTS);
+export const stepEnabled = (step, enabled) => enabled.includes(step);
+// Step lists to start a workflow from.
+export const TEMPLATES = {
+    build: { steps: ['vs-dev', 'vs-qa'], maxRounds: 3 },
+    'plan-and-build': { steps: ['vs-plan', 'vs-plan-review', 'vs-dev', 'vs-qa'], maxRounds: 3 },
+    'qa-only': { steps: ['vs-qa'], maxRounds: 1 },
+};
+export const DEFAULTS = {
+    engine: 'claude',
+    models: { dev: 'opus', review: 'sonnet' },
+    projects: {},
+    workflows: {},
+    reviewState: 'In Review',
+    timeoutMinutes: 45,
+    homes: [],
+    enabled: [],
+};
+export const agentsDir = (configDir) => join(configDir, 'agents');
+const configPath = (configDir) => join(agentsDir(configDir), 'config.json');
+export const hasWork = (workflow) => workflow.steps.some((s) => STEPS[s].output === 'commits');
+export const hasProducer = (workflow) => workflow.steps.some(isProducer);
+export const describeSteps = (steps) => steps.map((s) => STEPS[s].label).join(' → ');
+export const describeTriggers = (triggers) => triggers.map((t) => `${t.team} + ${t.label}`).join(', ');
+export const describeWorkflow = (c) => `when ${describeTriggers(c.triggers)}: ${describeSteps(c.steps)} in ${c.project}`;
+// Step ids that were folded into QA.
+const RENAMED = { 'vs-qa-review': 'vs-qa', ci: null, 'vs-qa-ui': null };
+const migrateStepList = (steps) => {
+    const mapped = steps.map((s) => (s in RENAMED ? RENAMED[s] : s)).filter((s) => !!s);
+    return mapped.filter((s, i) => !(s === 'vs-qa' && mapped[i - 1] === 'vs-qa'));
+};
+// Earlier shapes: a team mapped straight to a repo, then separate triggers
+// pointing at a workflow and a project. Both become workflows that own triggers.
+// Saved settings used to call workflows "chains".
+export function migrate(saved) {
+    const { repos, uiUrls: _uiUrls, maxRounds: _max, triggers, chains, ...rest } = saved;
+    const previous = saved.workflows ?? chains ?? {};
+    const projects = { ...(saved.projects ?? {}) };
+    const oldTriggers = [...(triggers ?? [])];
+    for (const [team, path] of Object.entries((repos ?? {}))) {
+        const name = basename(path);
+        projects[name] = { path };
+        oldTriggers.push({ team, label: 'vs-plan', chain: 'build', project: name });
+    }
+    // The browser check is gone, so its URL and model are dead settings.
+    for (const p of Object.values(projects))
+        delete p.uiUrl;
+    const models = rest.models && { ...rest.models };
+    if (models)
+        delete models.ui;
+    const workflows = {};
+    for (const [name, w] of Object.entries(previous)) {
+        if (w.project)
+            workflows[name] = { ...w, steps: migrateStepList(w.steps) };
+    }
+    for (const t of oldTriggers) {
+        const base = t.chain === 'review-only' ? 'qa-only' : t.chain;
+        const steps = TEMPLATES[base]?.steps ?? migrateStepList(previous[t.chain]?.steps ?? []);
+        if (!steps.length)
+            continue;
+        const name = `${t.project}-${base}`;
+        const workflow = workflows[name] ?? { triggers: [], steps, maxRounds: TEMPLATES[base]?.maxRounds ?? previous[t.chain]?.maxRounds ?? 3, project: t.project };
+        workflow.triggers.push({ source: 'linear', team: t.team, label: t.label });
+        workflows[name] = workflow;
+    }
+    const enabled = [...new Set((saved.enabled ?? []).map((a) => (a in RENAMED ? RENAMED[a] : a)).filter(Boolean))];
+    return { ...rest, ...(models ? { models } : {}), projects, workflows, enabled };
+}
+export function readAgentsConfig(configDir) {
+    const path = configPath(configDir);
+    if (!existsSync(path))
+        return structuredClone(DEFAULTS);
+    const saved = migrate(JSON.parse(readFileSync(path, 'utf8')));
+    return { ...structuredClone(DEFAULTS), ...saved, models: { ...DEFAULTS.models, ...saved.models } };
+}
+export function writeAgentsConfig(configDir, config) {
+    mkdirSync(agentsDir(configDir), { recursive: true });
+    writeFileSync(configPath(configDir), JSON.stringify(config, null, 2) + '\n');
+}

package/dist/control.d.ts

@@ -0,0 +1,25 @@
+import { type Current, type RunEntry } from './state.ts';
+import type { Check, ToolCommand, ToolContext } from './types.ts';
+export declare function parseAge(input: string): number | null;
+export declare function formatDuration(ms: number): string;
+export declare function stampDate(stamp: string): Date;
+export declare function countRounds(steps: {
+    result?: string;
+}[]): number;
+export declare const isInterrupted: (e: RunEntry, live: Current | null) => boolean;
+export declare function formatRunLine(e: RunEntry, now?: number, live?: Current | null): string;
+export declare function scanRunnerErrors(text: string, now: number): {
+    count: number;
+    last: string;
+};
+export declare function parsePlistArgs(plist: string): string[];
+export declare const controlUsage: Record<string, string>;
+export interface CancelDeps {
+    ours: (pid: number) => boolean;
+    kill: (pid: number, signal: 'SIGTERM' | 'SIGKILL') => void;
+    sleep: (ms: number) => Promise<void>;
+    cancelCard: (card: string, label: string) => Promise<boolean>;
+}
+export declare function cancelCurrent(ctx: ToolContext, c: Current, deps: CancelDeps): Promise<void>;
+export declare const controlCommands: Record<string, ToolCommand>;
+export declare function controlChecks(ctx: ToolContext): Promise<Check[]>;