akm-cli
Version:
akm (Agent Knowledge Manager) — a portable, local-first capability library for AI agents. Discover, load, share, and improve reusable skills, scripts, workflows, and knowledge across any shell-capable coding agent, including Claude Code, OpenCode, and Cur
538 lines (537 loc) • 26.2 kB
JavaScript
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
/**
* `akm proposal` command family (#225). Extracted verbatim from src/cli.ts
* (WS6) so the God Module shrinks; the `main.subCommands.proposal` key and
* every subcommand's args/output shape are byte-identical. Leaf handlers are
* migrated to `defineJsonCommand`, which wraps the body in `runWithJsonErrors`
* and emits the same JSON envelope (stdout/stderr/exit-code) as the inline
* `runWithJsonErrors` form it replaces.
*
* 0.9 CLI overhaul (S8): the former top-level `extract` and `propose`
* commands are absorbed here as `extract` and `new` — no top-level
* registration remains for either spelling.
*/
import { getParsedInvocation } from "../../cli/invocation.js";
import { parsePositiveIntFlag } from "../../cli/parse-args.js";
import { defineGroupCommand, defineJsonCommand, output } from "../../cli/shared.js";
import { resolveStashDir } from "../../core/common.js";
import { loadConfig } from "../../core/config/config.js";
import { UsageError } from "../../core/errors.js";
import { installLlmUsagePersistenceIfAbsent } from "../../llm/usage-persist.js";
import { withLlmStage } from "../../llm/usage-telemetry.js";
import { resolveImproveExecution } from "../improve/execution.js";
import { extractCommand } from "../improve/extract-cli.js";
import { resolveImproveStrategy } from "../improve/improve-strategies.js";
import { drainProposals } from "./drain.js";
import { akmProposalAccept, akmProposalDiff, akmProposalList, akmProposalReject, akmProposalReopen, akmProposalRevert, akmProposalShow, bulkAdjudicateProposals, } from "./proposal.js";
import { proposalWaitingSince } from "./proposal-types.js";
import { proposeCommand } from "./propose-cli.js";
export function mergeProposalDrainNotices(resolutionNotices, dispatchNotices) {
const byKey = new Map();
for (const notice of resolutionNotices ?? [])
byKey.set(JSON.stringify(notice), notice);
for (const notice of dispatchNotices ?? [])
byKey.set(JSON.stringify(notice), notice);
return byKey.size > 0 ? Object.freeze([...byKey.values()]) : undefined;
}
/**
* `--source` was renamed to `--generator` on `proposal accept`/`proposal
* reject` in 0.9 (WS3/S8 — "Removed in 0.9.0"). citty is non-strict, so the
* retired spelling is silently absorbed rather than rejected — a bulk
* accept/reject invoked with `--source <name>` then has neither `--generator`
* nor a positional id, and falls through to the single-proposal path, which
* throws MISSING_REQUIRED_ARGUMENT instead of running the bulk action the
* caller asked for. Reject it explicitly instead.
*/
function rejectRetiredProposalSourceFlag(subcommand) {
if (!getParsedInvocation().hasFlag("--source"))
return;
throw new UsageError(`\`akm proposal ${subcommand} --source\` was renamed to \`--generator\` in 0.9. Use \`--generator <name>\` instead.`, "INVALID_FLAG_VALUE");
}
/**
* Parse + validate the shared bulk-adjudication filter flags
* (`--max-diff-lines`, `--older-than`). Extracted from the two verbatim
* copies that lived in the accept and reject bulk branches (WI-6.6).
*/
function parseBulkFilterFlags(args) {
const rawMaxDiff = args["max-diff-lines"] ? Number.parseInt(String(args["max-diff-lines"]), 10) : undefined;
if (rawMaxDiff !== undefined && (Number.isNaN(rawMaxDiff) || rawMaxDiff < 0)) {
throw new UsageError("--max-diff-lines must be a non-negative integer", "INVALID_FLAG_VALUE");
}
const rawOlderThan = args["older-than"] ? Number.parseInt(String(args["older-than"]), 10) : undefined;
if (rawOlderThan !== undefined && (Number.isNaN(rawOlderThan) || rawOlderThan < 0)) {
throw new UsageError("--older-than must be a non-negative integer (days)", "INVALID_FLAG_VALUE");
}
return {
maxDiffLines: rawMaxDiff,
olderThanMs: rawOlderThan !== undefined ? rawOlderThan * 86_400_000 : undefined,
};
}
function parseProposalStatus(raw) {
if (raw === undefined)
return undefined;
const trimmed = raw.trim();
if (!trimmed)
return undefined;
if (trimmed === "pending" || trimmed === "accepted" || trimmed === "rejected" || trimmed === "reverted") {
return trimmed;
}
throw new UsageError(`Invalid --status value: "${raw}". Expected one of: pending, accepted, rejected, reverted.`, "INVALID_FLAG_VALUE");
}
const proposalListCommand = defineJsonCommand({
meta: { name: "list", description: "List proposal queue entries" },
args: {
queue: { type: "string", description: "Select the proposal queue by source name" },
status: {
type: "string",
description: "Filter by status (pending|accepted|rejected|reverted)",
},
ref: { type: "string", description: "Filter by asset ref ([bundle//]conceptId, e.g. knowledge/guide.md)" },
type: { type: "string", description: "Filter by asset type" },
generator: {
type: "string",
description: "Filter by generator/source (e.g. reflect, distill, consolidate-pair) — same value accept/reject --generator take.",
},
},
run({ args }) {
const status = parseProposalStatus(args.status);
const result = akmProposalList({
queue: args.queue,
status,
ref: args.ref,
type: args.type,
generator: args.generator,
includeArchive: status === "accepted" || status === "rejected" || status === "reverted",
});
output("proposal-list", result);
},
});
const proposalAcceptCommand = defineJsonCommand({
meta: { name: "accept", description: "Accept a proposal and promote it into the bundle" },
args: {
id: {
type: "positional",
description: "Proposal id (uuid / prefix) or asset ref (e.g. skills/akm-dream). Optional when --generator is provided.",
required: false,
},
queue: { type: "string", description: "Select the proposal queue by source name" },
target: { type: "string", description: "Write destination; must match the proposal's recorded target" },
// F-6 / #393: Batch accept by generator, diff size, or age.
generator: {
type: "string",
description: "Bulk-accept all pending proposals from this generator (e.g. reflect, distill). Requires no positional id.",
},
"max-diff-lines": {
type: "string",
description: "When bulk-accepting, only accept proposals whose content is <= this many lines. Skips larger proposals.",
},
"older-than": {
type: "string",
description: "When bulk-accepting, only accept proposals created (or last reopened) more than this many days ago (e.g. '7' for 7 days).",
},
"dry-run": {
type: "boolean",
description: "List proposals that would be bulk-accepted without accepting them.",
default: false,
},
yes: {
type: "boolean",
alias: "y",
description: "Skip confirmation prompt (required in non-interactive mode for bulk accept)",
default: false,
},
},
async run({ args }) {
rejectRetiredProposalSourceFlag("accept");
const generator = args.generator;
// F-6 / #393: Bulk-accept when --generator is provided without a positional id.
if (generator && !args.id) {
const { confirmDestructive } = await import("../../cli/confirm.js");
const confirmed = await confirmDestructive(`Bulk-accept all matching proposals from generator "${generator}"? This cannot be undone.`, { yes: args.yes === true || args["dry-run"] === true });
if (!confirmed) {
process.stderr.write("Aborted.\n");
return;
}
const { maxDiffLines, olderThanMs } = parseBulkFilterFlags(args);
const { count, results, skippedForContinuityRisk } = await bulkAdjudicateProposals({
action: "accept",
generator,
maxDiffLines,
olderThanMs,
dryRun: args["dry-run"],
queue: args.queue,
target: args.target,
});
output("proposal-accept-batch", {
accepted: count,
results,
// S4: how many otherwise-matching proposals were skipped specifically
// because they carry retirement.continuityRisk — visible under
// --dry-run and on a real run alike, distinct from an ordinary
// --max-diff-lines/--older-than miss.
skippedForContinuityRisk,
dryRun: args["dry-run"],
});
return;
}
if (!args.id) {
throw new UsageError("Usage: akm proposal accept <id> OR akm proposal accept --generator <generator>", "MISSING_REQUIRED_ARGUMENT");
}
const result = await akmProposalAccept({
id: args.id,
queue: args.queue,
target: args.target,
});
output("proposal-accept", result);
},
});
const proposalRejectCommand = defineJsonCommand({
meta: { name: "reject", description: "Reject a proposal and record the reason" },
args: {
id: {
type: "positional",
description: "Proposal id (uuid / prefix) or asset ref (e.g. skills/akm-dream). Optional when --generator is provided.",
required: false,
},
reason: { type: "string", description: "Reason for rejection (required)" },
queue: { type: "string", description: "Select the proposal queue by source name" },
// F-6 / #393: Batch reject by generator, diff size, or age.
generator: {
type: "string",
description: "Bulk-reject all pending proposals from this generator (e.g. reflect, distill). Requires no positional id.",
},
"max-diff-lines": {
type: "string",
description: "When bulk-rejecting, only reject proposals whose content is <= this many lines. Skips larger proposals.",
},
"older-than": {
type: "string",
description: "When bulk-rejecting, only reject proposals created (or last reopened) more than this many days ago (e.g. '7' for 7 days).",
},
"dry-run": {
type: "boolean",
description: "List proposals that would be bulk-rejected without rejecting them.",
default: false,
},
yes: {
type: "boolean",
alias: "y",
description: "Skip confirmation prompt (required in non-interactive mode)",
default: false,
},
},
async run({ args }) {
rejectRetiredProposalSourceFlag("reject");
const generator = args.generator;
if (!args.reason || !String(args.reason).trim()) {
throw new UsageError("Usage: akm proposal reject <id> --reason '<reason>' OR akm proposal reject --generator <generator> --reason '<reason>'", "MISSING_REQUIRED_ARGUMENT");
}
// F-6 / #393: Bulk-reject when --generator is provided without a positional id.
if (generator && !args.id) {
const { confirmDestructive } = await import("../../cli/confirm.js");
const confirmed = await confirmDestructive(`Bulk-reject all matching proposals from generator "${generator}"? A rejection can be undone with akm proposal reopen.`, { yes: args.yes === true || args["dry-run"] === true });
if (!confirmed) {
process.stderr.write("Aborted.\n");
return;
}
const { maxDiffLines, olderThanMs } = parseBulkFilterFlags(args);
const { count, results } = await bulkAdjudicateProposals({
action: "reject",
generator,
maxDiffLines,
olderThanMs,
dryRun: args["dry-run"],
queue: args.queue,
reason: String(args.reason),
});
output("proposal-reject-batch", { rejected: count, results, dryRun: args["dry-run"] });
return;
}
if (!args.id) {
throw new UsageError("Usage: akm proposal reject <id> --reason '<reason>' OR akm proposal reject --generator <generator> --reason '<reason>'", "MISSING_REQUIRED_ARGUMENT");
}
const { confirmDestructive } = await import("../../cli/confirm.js");
const confirmed = await confirmDestructive(`Reject proposal "${args.id}"? A rejection can be undone with akm proposal reopen.`, {
yes: args.yes === true,
});
if (!confirmed) {
process.stderr.write("Aborted.\n");
return;
}
const result = await akmProposalReject({
id: args.id,
queue: args.queue,
reason: String(args.reason),
});
output("proposal-reject", result);
},
});
// `proposal reopen` (#997): the undo a rejection lacked. Unlike `reject` it is
// reversible (reject again), so it asks no confirmation.
const proposalReopenCommand = defineJsonCommand({
meta: {
name: "reopen",
description: "Reopen rejected proposals: move them back to pending, keeping the rejection in their history. " +
"Takes full proposal ids; refused (and none reopened) if any is not rejected or its target changed since it was created.",
},
args: {
id: {
type: "positional",
description: "Rejected proposal id (full uuid); repeat it to reopen several at once",
required: true,
},
reason: {
type: "string",
description: "Why the rejection is being undone (kept in the proposal's review history)",
},
queue: { type: "string", description: "Select the proposal queue by source name" },
},
async run({ args }) {
// citty keeps every positional token in `_`, though it declares only `id`.
const ids = (Array.isArray(args._) && args._.length > 0 ? args._ : [args.id]).map(String);
const reason = typeof args.reason === "string" && args.reason.trim() ? args.reason.trim() : undefined;
const results = await akmProposalReopen({
ids,
queue: args.queue,
...(reason !== undefined ? { reason } : {}),
});
if (results.length === 1)
output("proposal-reopen", results[0]);
else
output("proposal-reopen-batch", { reopened: results.length, results });
},
});
const proposalDiffCommand = defineJsonCommand({
meta: { name: "diff", description: "Show the diff for a proposal (accepts full UUID, UUID prefix, or asset ref)" },
args: {
id: {
type: "positional",
description: "Proposal id (uuid / prefix) or asset ref (e.g. skills/akm-dream)",
required: true,
},
queue: { type: "string", description: "Select the proposal queue by source name" },
target: { type: "string", description: "Diff destination; must match the proposal's recorded target" },
},
run({ args }) {
const result = akmProposalDiff({ id: args.id, queue: args.queue, target: args.target });
output("proposal-diff", result);
},
});
// Phase 6C (Advantage D6c): revert an accepted proposal.
//
// Exit codes (mapped by `runWithJsonErrors` from the typed errors thrown by
// `akmProposalRevert` / `revertProposal`):
// 0 — success; prior content restored.
// 1 — generic error (also used by `UsageError("INVALID_FLAG_VALUE")` and
// `UsageError("MISSING_REQUIRED_ARGUMENT")` when the proposal is not
// accepted, or no backup is available).
// 1 — `NotFoundError("FILE_NOT_FOUND")` when the proposal id does not resolve.
const proposalRevertCommand = defineJsonCommand({
meta: {
name: "revert",
description: "Revert an accepted proposal: restore the prior asset content from the backup captured at promotion time. " +
"Errors if the proposal is not accepted or has no backup (new-asset proposals leave no backup). " +
"Accepts the full proposal UUID or the asset ref. UUID prefixes are not supported for archived proposals — use the full UUID.",
},
args: {
id: {
type: "positional",
description: "Proposal id (full uuid) or asset ref (e.g. skills/akm-dream). UUID prefixes are not supported for archived proposals — use the full UUID.",
required: true,
},
queue: { type: "string", description: "Select the proposal queue by source name" },
target: { type: "string", description: "Write destination; must match the proposal's recorded target" },
},
async run({ args }) {
const result = await akmProposalRevert({
id: args.id,
queue: args.queue,
target: args.target,
});
output("proposal-revert", result);
},
});
// `proposal show` (#225): show a single proposal with its validation findings.
const proposalShowCommand = defineJsonCommand({
meta: { name: "show", description: "Show a single proposal and its validation findings" },
args: {
id: {
type: "positional",
description: "Proposal id (uuid / prefix) or asset ref (e.g. skills/akm-dream)",
required: true,
},
queue: { type: "string", description: "Select the proposal queue by source name" },
},
run({ args }) {
const result = akmProposalShow({ id: args.id, queue: args.queue });
output("proposal-show", result);
},
});
const proposalDrainCommand = defineJsonCommand({
meta: {
name: "drain",
description: "Drain the pending proposal backlog: accept what a quality judge passed, reject empty diffs, leave the rest for judgment or review",
},
args: {
"dry-run": {
type: "boolean",
description: "List what would be accepted/rejected/deferred without writing.",
default: false,
},
yes: {
type: "boolean",
alias: "y",
description: "Skip confirmation prompt (required in non-interactive mode for promotion).",
default: false,
},
"max-accepts": {
type: "string",
description: "Hard per-run accept ceiling. Accepts beyond this are reported as skippedByCap.",
},
"older-than": {
type: "string",
description: "Only consider proposals created (or last reopened) more than this many days ago.",
},
promote: {
type: "boolean",
description: "Promote (accept) matching proposals. Default is queue mode (stage only, no writes to assets).",
default: false,
},
judgment: {
type: "boolean",
description: "Enable the judgment tier for this drain (overrides judgment.enabled=false; agent/sdk per config). No-op with a logged triage_deferred summary when no runner is configured.",
default: false,
},
strategy: {
type: "string",
description: "Read the triage block (applyMode, ceilings, judgment) from this improve strategy; enabled judgment runs the judge.",
},
},
async run({ args, rawArgs }) {
if (rawArgs.some((arg) => arg === "--profile" || arg.startsWith("--profile="))) {
throw new UsageError("proposal drain: --profile is retired; use --strategy.", "INVALID_FLAG_VALUE");
}
const stashDir = resolveStashDir();
const cfg = loadConfig();
// Phase 2: read the triage block from the named improve strategy. CLI flags
// always override config; config supplies defaults for any flag omitted.
const selectedStrategy = resolveImproveStrategy(args.strategy, cfg);
const triageConfig = selectedStrategy.config.processes?.triage;
const dryRun = args["dry-run"] === true;
const applyMode = args.promote === true ? "promote" : (triageConfig?.applyMode ?? "queue");
const maxAccepts = parsePositiveIntFlag(args["max-accepts"], "--max-accepts") ??
triageConfig?.maxAcceptsPerRun ??
25;
const rawOlderThan = parsePositiveIntFlag(args["older-than"], "--older-than");
const olderThanMs = rawOlderThan !== undefined ? rawOlderThan * 86_400_000 : undefined;
// Promotion in promote mode is destructive (commits to git, no batch revert).
if (applyMode === "promote" && !dryRun) {
const { confirmDestructive } = await import("../../cli/confirm.js");
const confirmed = await confirmDestructive("Drain and promote judge-passed pending proposals? Promotions commit to git and cannot be batch-reverted.", { yes: args.yes === true });
if (!confirmed) {
process.stderr.write("Aborted.\n");
return;
}
}
// `--older-than` is applied here as a pre-filter on excludeIds: ids that
// are too fresh are excluded so the engine never touches them. This reads
// the pending set once here; drainProposals reads the pending set again
// internally, so a future engine-level olderThan option could remove this
// second read (engine API owned by another agent — not changed here).
let excludeIds;
if (olderThanMs !== undefined) {
const { listProposals } = await import("./repository.js");
const now = Date.now();
excludeIds = new Set(listProposals(stashDir, { status: "pending" })
// Fail SAFE: exclude a proposal when its age cannot be computed
// (NaN date) OR it is too fresh. An unparseable date must never be
// treated as old enough to drain/promote. Age counts from creation,
// or from the last reopen (#997) — a proposal just reopened is fresh.
.filter((proposal) => {
const age = now - new Date(proposalWaitingSince(proposal)).getTime();
return Number.isNaN(age) || age < olderThanMs;
})
.map((proposal) => proposal.id));
}
// Phase 3: --judgment is an invocation-level opt-in that overrides a
// disabled block. An explicitly selected strategy may opt in through its
// judgment block; the implicit default strategy keeps standalone drain's
// historical no-judge behavior.
const judgmentResolution = args.judgment === true || (args.strategy !== undefined && triageConfig?.judgment?.enabled === true)
? resolveImproveExecution({
config: cfg,
profile: selectedStrategy.config,
process: triageConfig,
current: triageConfig?.judgment,
processName: "proposal-triage-judgment",
})
: null;
const judgment = judgmentResolution?.runner ?? null;
// #576: persist + attribute per-call LLM usage for the standalone drain
// path. `IfAbsent` keeps an enclosing `akm improve` sink in charge when
// drain runs as a sub-step; the disposer clears only a sink we installed.
const disposeDrainUsageSink = installLlmUsagePersistenceIfAbsent();
let result;
try {
result = await withLlmStage("drain", () => drainProposals({
stashDir,
config: cfg,
applyMode,
maxAccepts,
dryRun,
...(excludeIds ? { excludeIds } : {}),
judgment,
}));
}
finally {
disposeDrainUsageSink();
}
const dispatchNotices = result.notices;
const notices = mergeProposalDrainNotices(judgmentResolution?.notices, dispatchNotices);
output("proposal-drain", {
schemaVersion: 1,
ok: true,
applyMode,
dryRun,
strategy: selectedStrategy.name,
judgmentEngine: judgment?.engine ?? null,
judgmentKind: judgment?.kind ?? null,
...(notices ? { notices } : {}),
promoted: result.promoted,
rejected: result.rejected,
deferred: result.deferred,
skippedByCap: result.skippedByCap,
staged: result.staged,
failed: result.failed,
});
},
});
// ── proposal noun group ───────────────────────────────────────────────────────
export const proposalCommand = defineGroupCommand({
meta: {
name: "proposal",
description: "Manage the proposal queue: list, show, diff, accept, reject, reopen, revert, extract, new, drain",
},
// The group declared `--queue`/`--status`/`--ref`/`--type` only so the bare
// form could act as `proposal list`. That form is gone (see below), and
// `proposalListCommand` declares the identical set, so keeping them here
// would just advertise flags in `akm proposal --help` that no group-level
// body reads.
subCommands: {
list: proposalListCommand,
show: proposalShowCommand,
diff: proposalDiffCommand,
accept: proposalAcceptCommand,
reject: proposalRejectCommand,
reopen: proposalReopenCommand,
revert: proposalRevertCommand,
drain: proposalDrainCommand,
extract: extractCommand,
new: proposeCommand,
},
// No `defaultRun`: bare `akm proposal [--status …]` is a usage error (exit 2),
// the canonical bare-group behavior — owner ruling 12. `akm proposal list`
// takes the same flags and produces what the bare form used to.
});