@elmundi/ship-cli 0.14.2 → 0.15.4

package/lib/vendor/run-agent.workflow.yml

@@ -1,254 +0,0 @@
-# ship-cli: run-agent v1 — generated by `shipctl lanes install`.
-# Regenerate via: shipctl lanes install
-# Template ships with @elmundi/ship-cli; hand edits outside this banner may be overwritten.
-name: Ship · run-agent (reusable)
-# RFC-0007 Phase 3 + RFC-0008 C3.2 — reusable workflow for lane wrappers.
-# Caller repos use: uses: ./.github/workflows/run-agent.yml (same repository).
-
-on:
-  workflow_call:
-    inputs:
-      lane:
-        description: "Lane id as declared in .ship/config.yml"
-        type: string
-        required: true
-      trigger:
-        description: "Override trigger (once|event|schedule|manual). Defaults to github.event_name."
-        type: string
-        required: false
-        default: ""
-      shipctl_version:
-        description: "npm dist-tag or semver for @elmundi/ship-cli. Default: latest."
-        type: string
-        required: false
-        default: "latest"
-      node_version:
-        description: "Node.js major version for the runner"
-        type: string
-        required: false
-        default: "20"
-      dry_run:
-        description: "Resolve the lane but neither call the callback nor write the idempotency marker."
-        type: boolean
-        required: false
-        default: false
-      offline:
-        description: "Do not talk to the methodology API; read patterns from the local .ship/cache."
-        type: boolean
-        required: false
-        default: false
-      ship_run_id:
-        description: "Pipeline-run id the callback should report against (set by Ship dispatch)."
-        type: string
-        required: false
-        default: ""
-      ship_callback_url:
-        description: "Ship callback URL (set by Ship dispatch)."
-        type: string
-        required: false
-        default: ""
-      upload_prompt:
-        description: "Upload the rendered prompt as a workflow artifact named `ship-prompt`."
-        type: boolean
-        required: false
-        default: true
-    secrets:
-      SHIP_API_TOKEN:
-        description: "Methodology API token (optional; required for private patterns / callbacks)."
-        required: false
-      SHIP_API_BASE:
-        description: "Ship API origin for shipctl (e.g. https://api.example.com). Wizard seeds this from SHIP_PUBLIC_URL."
-        required: false
-      SHIP_RUN_TOKEN:
-        description: "Short-lived bearer token Ship issued when dispatching this run."
-        required: false
-
-permissions:
-  contents: read
-
-jobs:
-  plan:
-    name: "ship plan --lane ${{ inputs.lane }}"
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    outputs:
-      matrix: ${{ steps.plan.outputs.matrix }}
-      patterns: ${{ steps.plan.outputs.patterns }}
-      fanout: ${{ steps.plan.outputs.fanout }}
-    steps:
-      - name: Checkout caller repo
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ inputs.node_version }}
-
-      - name: Install shipctl
-        run: npm install -g @elmundi/ship-cli@${{ inputs.shipctl_version }}
-
-      - name: Resolve patterns + fanout
-        id: plan
-        env:
-          LANE: ${{ inputs.lane }}
-        run: |
-          set -euo pipefail
-          JSON=$(shipctl lanes list --json)
-          ROW=$(echo "$JSON" | jq -c --arg lane "$LANE" '.lanes[] | select(.lane == $lane)')
-          if [ -z "$ROW" ] || [ "$ROW" = "null" ]; then
-            echo "::error::lane '$LANE' not declared in .ship/config.yml"
-            exit 1
-          fi
-          PATTERNS=$(echo "$ROW" | jq -c '.patterns // []')
-          FANOUT=$(echo "$ROW" | jq -r '.fanout // "matrix"')
-          N=$(echo "$PATTERNS" | jq 'length')
-          if [ "$N" -lt 1 ]; then
-            echo "::error::lane '$LANE' declares no patterns"
-            exit 1
-          fi
-
-          if [ "$FANOUT" = "matrix" ] && [ "$N" -gt 1 ]; then
-            MATRIX=$(echo "$PATTERNS" | jq -c '[.[] | {pattern: ., fanout: "matrix"}]')
-          elif [ "$N" -gt 1 ]; then
-            MATRIX=$(jq -cn --arg fanout "$FANOUT" '[{pattern: "", fanout: $fanout}]')
-          else
-            MATRIX='[{"pattern": "", "fanout": "matrix"}]'
-          fi
-
-          echo "patterns=$PATTERNS" >> "$GITHUB_OUTPUT"
-          echo "fanout=$FANOUT"     >> "$GITHUB_OUTPUT"
-          echo "matrix=$MATRIX"     >> "$GITHUB_OUTPUT"
-          {
-            echo "### Plan"
-            echo "- lane: \`$LANE\`"
-            echo "- patterns: $(echo "$PATTERNS" | jq -r '. | join(", ")')"
-            echo "- fanout: $FANOUT"
-          } >> "$GITHUB_STEP_SUMMARY"
-
-  run:
-    name: "ship run --lane ${{ inputs.lane }} (pattern=${{ matrix.entry.pattern }} fanout=${{ matrix.entry.fanout }})"
-    needs: plan
-    runs-on: ubuntu-latest
-    timeout-minutes: 20
-    strategy:
-      fail-fast: false
-      matrix:
-        entry: ${{ fromJSON(needs.plan.outputs.matrix) }}
-    steps:
-      - name: Checkout caller repo
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ inputs.node_version }}
-
-      - name: Install shipctl
-        run: npm install -g @elmundi/ship-cli@${{ inputs.shipctl_version }}
-
-      - name: Resolve trigger
-        id: trigger
-        env:
-          OVERRIDE: ${{ inputs.trigger }}
-          EVENT: ${{ github.event_name }}
-        run: |
-          set -euo pipefail
-          if [ -n "${OVERRIDE:-}" ]; then
-            echo "value=$OVERRIDE" >> "$GITHUB_OUTPUT"
-          else
-            case "$EVENT" in
-              workflow_dispatch) echo "value=manual" >> "$GITHUB_OUTPUT" ;;
-              schedule)          echo "value=schedule" >> "$GITHUB_OUTPUT" ;;
-              *)                 echo "value=event" >> "$GITHUB_OUTPUT" ;;
-            esac
-          fi
-
-      - name: shipctl run
-        id: run
-        env:
-          SHIP_API_TOKEN: ${{ secrets.SHIP_API_TOKEN }}
-          SHIP_API_BASE: ${{ secrets.SHIP_API_BASE }}
-          SHIP_RUN_TOKEN: ${{ secrets.SHIP_RUN_TOKEN }}
-          SHIP_RUN_ID: ${{ inputs.ship_run_id }}
-          MATRIX_PATTERN: ${{ matrix.entry.pattern }}
-          MATRIX_FANOUT:  ${{ matrix.entry.fanout }}
-        run: |
-          set -euo pipefail
-          mkdir -p .ship/run-output
-          ARGS=(run --lane "${{ inputs.lane }}" --trigger "${{ steps.trigger.outputs.value }}")
-          [ "${{ inputs.dry_run }}" = "true" ] && ARGS+=(--dry-run)
-          [ "${{ inputs.offline }}" = "true" ] && ARGS+=(--offline)
-          [ -n "${MATRIX_PATTERN:-}" ] && ARGS+=(--pattern "$MATRIX_PATTERN")
-          [ -n "${MATRIX_FANOUT:-}"  ] && ARGS+=(--fanout  "$MATRIX_FANOUT")
-          [ -n "${SHIP_RUN_ID:-}"    ] && ARGS+=(--ship-run-id "$SHIP_RUN_ID")
-
-          set +e
-          shipctl "${ARGS[@]}" \
-            1> .ship/run-output/prompt.md \
-            2> .ship/run-output/shipctl.log
-          STATUS=$?
-          set -e
-
-          cat .ship/run-output/shipctl.log >&2 || true
-          echo "status=$STATUS" >> "$GITHUB_OUTPUT"
-          if [ "$STATUS" -ne 0 ]; then
-            echo "::error::shipctl run exited with $STATUS"
-            exit "$STATUS"
-          fi
-
-      - name: Upload prompt artifact
-        if: ${{ inputs.upload_prompt && (success() || failure()) }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: ship-prompt-${{ inputs.lane }}${{ matrix.entry.pattern != '' && format('-{0}', matrix.entry.pattern) || '' }}
-          path: .ship/run-output/
-          if-no-files-found: warn
-          retention-days: 14
-
-  aggregate:
-    name: "ship aggregate --lane ${{ inputs.lane }}"
-    if: ${{ always() && inputs.ship_callback_url != '' }}
-    needs: [plan, run]
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    steps:
-      - name: Checkout caller repo
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ inputs.node_version }}
-
-      - name: Install shipctl
-        run: npm install -g @elmundi/ship-cli@${{ inputs.shipctl_version }}
-
-      - name: Report rollup to Ship
-        env:
-          SHIP_RUN_ID: ${{ inputs.ship_run_id }}
-          SHIP_CALLBACK_URL: ${{ inputs.ship_callback_url }}
-          SHIP_RUN_TOKEN: ${{ secrets.SHIP_RUN_TOKEN }}
-          GH_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
-          RUN_RESULT: ${{ needs.run.result }}
-          PLAN_PATTERNS: ${{ needs.plan.outputs.patterns }}
-          PLAN_FANOUT: ${{ needs.plan.outputs.fanout }}
-        run: |
-          set -euo pipefail
-          case "$RUN_RESULT" in
-            success)
-              CB=ok
-              SUMMARY="Ship lane ${{ inputs.lane }} completed ($PLAN_FANOUT over $PLAN_PATTERNS)."
-              ;;
-            failure|cancelled|skipped|*)
-              CB=fail
-              SUMMARY="Ship lane ${{ inputs.lane }} $RUN_RESULT ($PLAN_FANOUT over $PLAN_PATTERNS)."
-              ;;
-          esac
-          shipctl callback --status "$CB" \
-            --summary "$SUMMARY" \
-            --metric "lane_id=${{ inputs.lane }}" \
-            --metric "fanout=$PLAN_FANOUT" \
-            --metric "patterns=$(echo "$PLAN_PATTERNS" | jq -r '. | join(",")')" \
-            --metric "gh_workflow_run_id=${{ github.run_id }}" \
-            --metric "gh_html_url=$GH_RUN_URL" \
-            --metric "gh_event=${{ github.event_name }}" || true

package/lib/verify/checks/artifacts-up-to-date.mjs

@@ -1,78 +0,0 @@
-import { fetchManifest } from "../../http.mjs";
-import { listCached } from "../../cache/store.mjs";
-
-export const id = "artifacts-up-to-date";
-export const category = "network";
-export const description = "Local cache matches latest manifest on the configured channel";
-
-function newestVersion(versions) {
-  if (!Array.isArray(versions) || !versions.length) return null;
-  // Manifest entries are usually already sorted descending; treat the first as latest.
-  return versions[0];
-}
-
-/**
- * @param {import("../registry.mjs").CheckContext} ctx
- */
-export async function run(ctx) {
-  let cache;
-  try {
-    cache = listCached(ctx.cwd);
-  } catch {
-    cache = [];
-  }
-  if (!cache.length) {
-    return { status: "skip", detail: "no cached artifacts to compare" };
-  }
-
-  const baseUrl = ctx.baseUrl
-    || (ctx.config && ctx.config.api && ctx.config.api.base_url)
-    || process.env.SHIP_API_BASE
-    || "https://ship.elmundi.com";
-  const channel = (ctx.config && ctx.config.api && ctx.config.api.channel) || "stable";
-
-  let manifest;
-  try {
-    manifest = await fetchManifest(baseUrl, { channel });
-  } catch (e) {
-    return { status: "warn", detail: `manifest fetch failed: ${e.message}` };
-  }
-
-  const index = new Map();
-  for (const m of manifest || []) {
-    const k = `${m.kind}/${m.id}`;
-    if (!index.has(k)) index.set(k, m);
-  }
-
-  const stale = [];
-  for (const entry of cache) {
-    const key = `${entry.kind}/${entry.id}`;
-    const m = index.get(key);
-    if (!m) continue;
-    const latest = m.version || (m.versions ? newestVersion(m.versions) : null);
-    if (latest && entry.version && latest !== entry.version) {
-      stale.push({
-        kind: entry.kind,
-        id: entry.id,
-        cached: entry.version,
-        latest,
-      });
-    }
-  }
-
-  if (stale.length) {
-    const summary = stale
-      .slice(0, 3)
-      .map((s) => `${s.kind}/${s.id} ${s.cached}→${s.latest}`)
-      .join(", ");
-    return {
-      status: "warn",
-      detail: `${stale.length} stale artifact(s): ${summary}${stale.length > 3 ? "…" : ""} — run 'shipctl sync'`,
-      data: { stale, channel },
-    };
-  }
-  return {
-    status: "pass",
-    detail: `all ${cache.length} cached entries are current on channel=${channel}`,
-  };
-}

package/lib/verify/checks/cache-integrity.mjs

@@ -1,51 +0,0 @@
-import { listCached, verifyCached } from "../../cache/store.mjs";
-
-export const id = "cache-integrity";
-export const category = "local";
-export const description = "Cached artifact bodies match their .meta.json sha256";
-
-/**
- * @param {import("../registry.mjs").CheckContext} ctx
- */
-export async function run(ctx) {
-  let entries = [];
-  try {
-    entries = listCached(ctx.cwd);
-  } catch (e) {
-    return { status: "fail", detail: `failed to read cache index: ${e.message}` };
-  }
-  if (!entries.length) {
-    return { status: "skip", detail: "no cached artifacts (.ship/cache/)" };
-  }
-
-  const tampered = [];
-  for (const e of entries) {
-    const res = verifyCached(ctx.cwd, e.kind, e.id, e.version);
-    if (!res.ok) {
-      tampered.push({
-        kind: e.kind,
-        id: e.id,
-        version: e.version,
-        expected: res.expected,
-        actual: res.actual,
-        reason: res.reason || "sha256 mismatch",
-      });
-    }
-  }
-
-  if (tampered.length) {
-    return {
-      status: "fail",
-      detail: `${tampered.length}/${entries.length} cached entries tampered: ${tampered
-        .slice(0, 3)
-        .map((t) => `${t.kind}/${t.id}@${t.version}`)
-        .join(", ")}${tampered.length > 3 ? "…" : ""}`,
-      data: { tampered, total: entries.length },
-    };
-  }
-  return {
-    status: "pass",
-    detail: `${entries.length} cached entries verified (sha256 ok)`,
-    data: { total: entries.length },
-  };
-}

package/lib/verify/checks/gitignore-cache.mjs

@@ -1,51 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-
-export const id = "gitignore-cache";
-export const category = "local";
-export const description = ".gitignore contains .ship/cache/";
-
-/**
- * @param {import("../registry.mjs").CheckContext} ctx
- */
-export async function run(ctx) {
-  const cacheTracked =
-    !!(ctx.config && ctx.config.cache && ctx.config.cache.vcs_tracked === true);
-  const giPath = path.join(ctx.cwd, ".gitignore");
-  if (!fs.existsSync(giPath)) {
-    if (cacheTracked) {
-      return {
-        status: "pass",
-        detail: ".gitignore absent but cache.vcs_tracked=true — cache is intentionally committed",
-      };
-    }
-    return {
-      status: "warn",
-      detail: ".gitignore not found; add `.ship/cache/` to keep cached artifacts out of git",
-    };
-  }
-  const body = fs.readFileSync(giPath, "utf8");
-  const lines = new Set(body.split(/\r?\n/).map((l) => l.trim()));
-  const listed = lines.has(".ship/cache/") || lines.has(".ship/cache");
-
-  if (cacheTracked && listed) {
-    return {
-      status: "warn",
-      detail:
-        ".ship/cache/ listed in .gitignore but cache.vcs_tracked=true — entries will be ignored by git",
-    };
-  }
-  if (cacheTracked) {
-    return {
-      status: "pass",
-      detail: "cache.vcs_tracked=true; .gitignore does not exclude .ship/cache/",
-    };
-  }
-  if (!listed) {
-    return {
-      status: "warn",
-      detail: ".ship/cache/ not listed in .gitignore — add it to avoid committing cached bodies",
-    };
-  }
-  return { status: "pass", detail: ".ship/cache/ listed in .gitignore" };
-}

package/lib/verify/checks/rules-markers.mjs

@@ -1,135 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import { KNOWN_AGENTS } from "../../detect.mjs";
-import { listCached, readCachedArtifact } from "../../cache/store.mjs";
-
-export const id = "rules-markers";
-export const category = "local";
-export const description = "Agent rule files contain current artifacts-protocol markers";
-
-const RULE_MARKER = "<!-- ship-cli: artifacts-protocol v1 -->";
-const FOOTER_PREFIX = "<!-- ship-cli: installed-from ";
-const FOOTER_SUFFIX = " -->";
-
-function readFooter(body) {
-  const idx = body.lastIndexOf(FOOTER_PREFIX);
-  if (idx < 0) return null;
-  const end = body.indexOf(FOOTER_SUFFIX, idx);
-  if (end < 0) return null;
-  return body.slice(idx + FOOTER_PREFIX.length, end).trim();
-}
-
-/**
- * @param {import("../registry.mjs").CheckContext} ctx
- */
-export async function run(ctx) {
-  const agents = (ctx.config && ctx.config.stack && Array.isArray(ctx.config.stack.agents))
-    ? ctx.config.stack.agents
-    : [];
-  if (!agents.length) {
-    return { status: "skip", detail: "stack.agents is empty" };
-  }
-
-  let cache = [];
-  try {
-    cache = listCached(ctx.cwd);
-  } catch {
-    cache = [];
-  }
-
-  const rows = [];
-  let hasFail = false;
-  let hasWarn = false;
-
-  for (const agent of agents) {
-    const spec = KNOWN_AGENTS[agent];
-    // Prefer the install_target declared by the cached agent-rules artifact;
-    // fall back to the hardcoded KNOWN_AGENTS mapping for graceful
-    // degradation when the cache hasn't been populated yet (RFC-0004).
-    let rel = null;
-    let cachedFm = null;
-    try {
-      cachedFm = readCachedArtifact(ctx.cwd, "collection", `agent-rules-${agent}`);
-    } catch {
-      cachedFm = null;
-    }
-    if (!cachedFm) {
-      rows.push({
-        agent,
-        status: "warn",
-        detail: `no cached agent-rules-${agent}; run shipctl sync`,
-      });
-      hasWarn = true;
-      continue;
-    }
-    // v1 single-file artifacts kept install_target at the top level; v2
-    // moved it under `spec:`. Honour both.
-    const topLevel = cachedFm.fm && typeof cachedFm.fm.install_target === "string"
-      ? cachedFm.fm.install_target.trim()
-      : "";
-    const nested = cachedFm.spec && typeof cachedFm.spec.install_target === "string"
-      ? cachedFm.spec.install_target.trim()
-      : "";
-    const installTarget = topLevel || nested;
-    if (installTarget) {
-      rel = installTarget;
-    } else if (spec) {
-      rel = path.join(...spec.targetRel);
-    } else {
-      rows.push({ agent, status: "warn", detail: `unknown agent id '${agent}' (no install_target and no KNOWN_AGENTS entry)` });
-      hasWarn = true;
-      continue;
-    }
-
-    const abs = path.join(ctx.cwd, rel);
-    if (!fs.existsSync(abs)) {
-      rows.push({ agent, status: "fail", detail: `missing rule file ${rel}` });
-      hasFail = true;
-      continue;
-    }
-    const body = fs.readFileSync(abs, "utf8");
-    if (!body.includes(RULE_MARKER)) {
-      rows.push({ agent, status: "fail", detail: `${rel} has no '${RULE_MARKER}' marker` });
-      hasFail = true;
-      continue;
-    }
-    const footer = readFooter(body);
-    if (!footer) {
-      rows.push({ agent, status: "fail", detail: `${rel} has no 'installed-from' footer` });
-      hasFail = true;
-      continue;
-    }
-
-    // footer looks like "collection/agent-rules-cursor@1.0.1"
-    const m = /^collection\/agent-rules-[a-z0-9-]+@([0-9A-Za-z.\-+]+)$/.exec(footer);
-    if (!m) {
-      rows.push({ agent, status: "warn", detail: `${rel} footer is '${footer}' (non-standard format)` });
-      hasWarn = true;
-      continue;
-    }
-    const installedVersion = m[1];
-    const cached = cache.find(
-      (c) => c.kind === "collection" && c.id === `agent-rules-${agent}`,
-    );
-    if (cached && cached.version && cached.version !== installedVersion) {
-      rows.push({
-        agent,
-        status: "warn",
-        detail: `${rel} footer @${installedVersion}, cache has @${cached.version} — run 'shipctl init --copy-rules'`,
-      });
-      hasWarn = true;
-    } else {
-      rows.push({ agent, status: "pass", detail: `${rel} @${installedVersion}` });
-    }
-  }
-
-  const overall = hasFail ? "fail" : hasWarn ? "warn" : "pass";
-  const summary = rows
-    .filter((r) => r.status !== "pass")
-    .map((r) => `${r.agent}: ${r.detail}`)
-    .join("; ");
-  const detail = overall === "pass"
-    ? `all ${rows.length} agent rule files have correct markers`
-    : summary || `${rows.length} agent rule files inspected`;
-  return { status: overall, detail, data: { rows } };
-}