snipara-companion 2.0.8 → 2.0.10

package/README.md

@@ -1,5 +1,10 @@
 # snipara-companion
 
+[![npm version](https://img.shields.io/npm/v/snipara-companion.svg)](https://www.npmjs.com/package/snipara-companion)
+[![CI](https://github.com/Snipara/snipara-companion/actions/workflows/ci.yml/badge.svg)](https://github.com/Snipara/snipara-companion/actions/workflows/ci.yml)
+[![MIT License](https://img.shields.io/badge/license-MIT-yellow.svg)](./LICENSE)
+[![Node >=18](https://img.shields.io/badge/node-%3E%3D18-339933.svg)](./package.json)
+
 **Ask your repo what breaks if you touch this.**
 
 No global install. No `init`. No account. Your code stays on your machine.
@@ -39,7 +44,7 @@ These commands are useful without hosted Snipara:
 | `code callers` / `imports` / `neighbors` / `shortest-path`   | Structural repo questions from local files                   |
 | `workflow start` / `phase-start` / `phase-commit` / `resume` | Agent continuity that survives compaction                    |
 | `context-pack`                                               | Reversible local packs for long logs, diffs, and tool output |
-| `judgment-card`, `verify`, `references`                      | Local review artifacts and source-backed references          |
+| `judgment-card`, `verify`, `agent-readiness`, `references`   | Local review artifacts, readiness audits, and references     |
 | `stuck-guard`, `memory-guard`, `pre-tool`, `post-tool`       | Fail-soft local guards and hook helpers                      |
 
 ## Agent Continuity

package/dist/index.d.ts

@@ -2045,6 +2045,112 @@ declare function memoryLocalCommand(options: LocalMemoryCommandOptions): Promise
 declare function evalExportCommand(options: EvalExportOptions): Promise<void>;
 declare function evalRunCommand(options: EvalRunOptions): Promise<void>;
 
+type AgentReadinessTarget = "codex" | "claude-code" | "cursor" | "orca" | "windsurf" | "custom";
+type AgentReadinessCheckStatus = "pass" | "warning" | "fail" | "manual";
+type AgentReadinessGapSeverity = "low" | "medium" | "high" | "blocker";
+type AgentReadinessScoreBand = "ready" | "mostly_ready" | "needs_hardening" | "blocked";
+type AgentReadinessServiceTier = "launch_review" | "enablement_pack" | "hardening_sprint";
+interface AgentReadinessAuditCommandOptions {
+    target?: string;
+    task?: string;
+    changedFiles?: string[];
+    context?: string[];
+    proof?: string[];
+    acceptance?: string[];
+    risk?: string[];
+    dir?: string;
+    output?: string;
+    json?: boolean;
+}
+interface AgentReadinessWorkflowState {
+    present: boolean;
+    path: string;
+    status?: string;
+    workflowId?: string;
+    currentPhaseId?: string;
+    completedPhases: number;
+    pendingPhases: number;
+}
+interface AgentReadinessTeamSyncState {
+    present: boolean;
+    path: string;
+    activeWorkCount: number;
+    handoffCount: number;
+    latestActiveSummary?: string;
+    latestHandoffSummary?: string;
+}
+interface AgentReadinessProjectInstructions {
+    present: boolean;
+    path: string;
+}
+interface AgentReadinessLocalSignals {
+    workflow: AgentReadinessWorkflowState;
+    teamSync: AgentReadinessTeamSyncState;
+    projectInstructions: AgentReadinessProjectInstructions;
+}
+interface AgentReadinessCheck {
+    id: string;
+    title: string;
+    status: AgentReadinessCheckStatus;
+    severity: AgentReadinessGapSeverity;
+    score: number;
+    maxScore: number;
+    evidence: string[];
+    action: string;
+}
+interface AgentReadinessGap {
+    checkId: string;
+    severity: AgentReadinessGapSeverity;
+    message: string;
+    action: string;
+}
+interface AgentReadinessRecommendedServicePack {
+    id: AgentReadinessServiceTier;
+    name: string;
+    duration: string;
+    fit: string;
+    deliverables: string[];
+    exitCriteria: string[];
+}
+interface AgentReadinessAuditReport {
+    version: "snipara.agent_readiness_audit.v1";
+    generatedAt: string;
+    target: {
+        id: AgentReadinessTarget;
+        label: string;
+        posture: string;
+    };
+    task?: string;
+    score: {
+        total: number;
+        band: AgentReadinessScoreBand;
+        max: 100;
+        summary: string;
+    };
+    checks: AgentReadinessCheck[];
+    gaps: AgentReadinessGap[];
+    explicitInputs: {
+        changedFiles: string[];
+        contextRefs: string[];
+        proofGates: string[];
+        acceptanceCriteria: string[];
+        declaredRisks: string[];
+    };
+    localSignals: AgentReadinessLocalSignals;
+    recommendedServicePack: AgentReadinessRecommendedServicePack;
+    suggestedCommands: string[];
+    caveats: string[];
+}
+interface BuildAgentReadinessAuditOptions extends AgentReadinessAuditCommandOptions {
+    cwd?: string;
+    now?: Date;
+    localSignals?: AgentReadinessLocalSignals;
+}
+declare function collectAgentReadinessLocalSignals(rootDir?: string): AgentReadinessLocalSignals;
+declare function buildAgentReadinessAuditReport(options?: BuildAgentReadinessAuditOptions): AgentReadinessAuditReport;
+declare function formatAgentReadinessAuditReport(report: AgentReadinessAuditReport): string;
+declare function agentReadinessAuditCommand(options: AgentReadinessAuditCommandOptions): Promise<void>;
+
 type ProjectPolicyGateSeverity = "advisory" | "required_action" | "block";
 type ProjectPolicyGateSurface = "release" | "schema" | "auth" | "billing" | "deploy" | "package_surface";
 type ProjectPolicyGateSampleMode = "not_applicable" | "structural" | "explicit_contract" | "sample_gated";
@@ -2835,6 +2941,12 @@ interface TeamSyncCommandOptions {
     next?: string;
     attention?: string;
     risk?: string;
+    adapterPack?: boolean;
+    adapterTarget?: string;
+    context?: string[];
+    proof?: string[];
+    acceptance?: string[];
+    conflictPosture?: string;
     since?: string;
     dir?: string;
     includeSessionContext?: boolean;
@@ -2861,6 +2973,39 @@ interface TeamSyncSweepResult {
     archivedWork: TeamSyncWorkRecord[];
     summary: TeamSyncSummary;
 }
+type AgenticHandoffAdapterTarget = "codex" | "claude-code" | "cursor" | "orca" | "windsurf" | "custom";
+type AgenticHandoffConflictPosture = "continue" | "wait" | "split_work" | "review_only" | "handoff";
+interface AgenticHandoffAdapterPack {
+    version: "snipara.ade_adapter_pack.v1";
+    target: {
+        id: AgenticHandoffAdapterTarget;
+        label: string;
+        instruction: string;
+    };
+    contextPack: {
+        summary: string;
+        files: string[];
+        contextRefs: string[];
+        workflow?: {
+            goal?: string;
+            status?: string;
+            currentPhaseId?: string;
+            currentPhaseTitle?: string;
+        };
+        resumeCommands: string[];
+        constraints: string[];
+    };
+    conflictPosture: AgenticHandoffConflictPosture;
+    proofGates: string[];
+    acceptanceCriteria: string[];
+    receiptExpectation: {
+        required: boolean;
+        command: string;
+        requiredFields: string[];
+    };
+    prompt: string;
+    caveats: string[];
+}
 interface TeamSyncCompletionEvidenceOptions {
     summary?: string;
     workflowGoal?: string;
@@ -2888,6 +3033,7 @@ interface AgenticHandoffArtifact {
         whereToResume: string[];
     };
     suggestedCommands: string[];
+    adapter?: AgenticHandoffAdapterPack;
 }
 declare function buildTeamSyncStartWorkRecord(input: TeamSyncRecordInput): TeamSyncWorkRecord;
 declare function buildTeamSyncHandoffRecord(input: TeamSyncRecordInput): TeamSyncHandoffRecord;
@@ -3308,4 +3454,4 @@ declare function buildOrchestratorHandoff(options: OrchestratorHandoffOptions):
 declare function buildAdaptiveWorkRoutingRecommendation(options: AdaptiveWorkRoutingOptions): AdaptiveWorkRoutingRecommendation;
 declare function writeOrchestratorHandoff(options: OrchestratorHandoffOptions): WrittenOrchestratorHandoff;
 
-export { AUTOMATION_MANIFEST_RELATIVE_PATH, AutomationInstallConflictError, AutomationUnsupportedHookBundleError, COLLABORATION_STATE_RELATIVE_PATH, ORCHESTRATOR_HANDOFF_RELATIVE_PATH, TEAM_SYNC_STATE_RELATIVE_PATH, WORKFLOW_PLANS_RELATIVE_DIR, WORKFLOW_STATE_RELATIVE_PATH, archiveInactiveTeamSyncWork, attachLocalContextPackReceipts, autoArchiveTeamSyncState, buildAdaptiveWorkRoutingRecommendation, buildAgenticHandoffMarkdown, buildAgenticTimeline, buildAgenticWorkStatus, buildAutomationInstallPlan, buildCanonicalEvent, buildCodeHooksInstallPlan, buildCodePromotionResult, buildCodeStatusResult, buildCodeSyncResult, buildCollaborationActor, buildCollaborationGuardActionCards, buildCollaborationHooksInstallPlan, buildContextPackStats, buildEvalCaseArtifact, buildGeneratedWorkflowPlanDocument, buildHostedCodeOverlayUploadPayload, buildHostedGuardPayload, buildJournalCheckpointEntry, buildLocalCallersResult, buildLocalCodeOverlay, buildLocalContextPackReceipt, buildLocalContextPackReceipts, buildLocalImpactResult, buildLocalImportsResult, buildLocalNeighborsResult, buildLocalShortestPathResult, buildMemoryAudit, buildOnboardFolderManifest, buildOrchestratorHandoff, buildProjectIntelligenceBrief, buildProjectIntelligenceRun, buildProjectJudgmentCard, buildSessionBootstrapQuality, buildSyncDocumentsDryRun, buildTeamSyncHandoffRecord, buildTeamSyncStartWorkRecord, buildTeamSyncSummary, buildToolCallPayload, buildToolResultPayload, buildVerificationPlan, buildWorkflowImpactGate, buildWorkflowPhaseCommitSummary, buildWorkflowPlanScaffold, categoryFromGuardTag, classifyToolResult, cleanContextPacks, collaborationIdeStatusCommand, collectSyncDocuments, collectSyncDocumentsInput, compactHostedGuardResources, completeTeamSyncStateFromEvidence, completeTeamSyncWorkFromEvidence, contextPackCleanCommand, contextPackPackCommand, contextPackRetrieveCommand, contextPackStatsCommand, createClient, createEmptyCollaborationState, createEmptyTeamSyncState, createLocalQueryCache, deriveLocalCollaborationResourcesFromFiles, detectReleaseSurfacesFromFiles, detectRuntimeEnvironment, evalExportCommand, evalRunCommand, evaluateProjectPolicyGates, extractCommandFromToolInput, extractFilesFromToolInput, formatOrchestratorRecommendationReason, formatPolicyGateDecision, formatProjectJudgmentCard, formatStuckGuardDecision, getAutomationManifestPath, getAutomationStatus, getCollaborationStatePath, getConfigPath, getContextPackStoragePaths, getLocalCodeOverlayCachePath, getLocalCodePromotionStatePath, getOrchestratorRecommendation, getPlanStepDisplayTitle, getStagedFiles, getStuckGuardInjection, getTeamSyncStatePath, ingestReferences, installAutomationBundle, listProjectsForApiKey, loadAutomationManifest, loadCollaborationState, loadConfig, loadTeamSyncState, memoryAuditCommand, memoryCleanCandidatesCommand, memoryCompactCommand, memoryHealthCommand, memoryLocalCommand, normalizeCollaborationFiles, normalizeGuardTag, normalizeWorkflowPlanInput, packContext, parseCollaborationResources, projectIntelligenceBriefCommand, projectIntelligenceRunCommand, readLocalCodeOverlayCache, readLocalCodePromotionState, referencesIngestCommand, referencesScanCommand, resolveContextPackRecord, resolveFullWorkflowTokenBudget, resolveQueryFromToolInput, retrieveContextPack, runMemoryGuardCheck, saveCollaborationState, saveConfig, saveTeamSyncState, scanReferences, shouldSuggestOrchestratorForWorkflow, shouldSuggestRuntimeForWorkflow, summarizeLocalCodeOverlay, teamSyncSweepCommand, validatePlanResult, verifyCommand, writeLocalCodeOverlayCache, writeLocalCodePromotionState, writeOrchestratorHandoff };
+export { AUTOMATION_MANIFEST_RELATIVE_PATH, AutomationInstallConflictError, AutomationUnsupportedHookBundleError, COLLABORATION_STATE_RELATIVE_PATH, ORCHESTRATOR_HANDOFF_RELATIVE_PATH, TEAM_SYNC_STATE_RELATIVE_PATH, WORKFLOW_PLANS_RELATIVE_DIR, WORKFLOW_STATE_RELATIVE_PATH, agentReadinessAuditCommand, archiveInactiveTeamSyncWork, attachLocalContextPackReceipts, autoArchiveTeamSyncState, buildAdaptiveWorkRoutingRecommendation, buildAgentReadinessAuditReport, buildAgenticHandoffMarkdown, buildAgenticTimeline, buildAgenticWorkStatus, buildAutomationInstallPlan, buildCanonicalEvent, buildCodeHooksInstallPlan, buildCodePromotionResult, buildCodeStatusResult, buildCodeSyncResult, buildCollaborationActor, buildCollaborationGuardActionCards, buildCollaborationHooksInstallPlan, buildContextPackStats, buildEvalCaseArtifact, buildGeneratedWorkflowPlanDocument, buildHostedCodeOverlayUploadPayload, buildHostedGuardPayload, buildJournalCheckpointEntry, buildLocalCallersResult, buildLocalCodeOverlay, buildLocalContextPackReceipt, buildLocalContextPackReceipts, buildLocalImpactResult, buildLocalImportsResult, buildLocalNeighborsResult, buildLocalShortestPathResult, buildMemoryAudit, buildOnboardFolderManifest, buildOrchestratorHandoff, buildProjectIntelligenceBrief, buildProjectIntelligenceRun, buildProjectJudgmentCard, buildSessionBootstrapQuality, buildSyncDocumentsDryRun, buildTeamSyncHandoffRecord, buildTeamSyncStartWorkRecord, buildTeamSyncSummary, buildToolCallPayload, buildToolResultPayload, buildVerificationPlan, buildWorkflowImpactGate, buildWorkflowPhaseCommitSummary, buildWorkflowPlanScaffold, categoryFromGuardTag, classifyToolResult, cleanContextPacks, collaborationIdeStatusCommand, collectAgentReadinessLocalSignals, collectSyncDocuments, collectSyncDocumentsInput, compactHostedGuardResources, completeTeamSyncStateFromEvidence, completeTeamSyncWorkFromEvidence, contextPackCleanCommand, contextPackPackCommand, contextPackRetrieveCommand, contextPackStatsCommand, createClient, createEmptyCollaborationState, createEmptyTeamSyncState, createLocalQueryCache, deriveLocalCollaborationResourcesFromFiles, detectReleaseSurfacesFromFiles, detectRuntimeEnvironment, evalExportCommand, evalRunCommand, evaluateProjectPolicyGates, extractCommandFromToolInput, extractFilesFromToolInput, formatAgentReadinessAuditReport, formatOrchestratorRecommendationReason, formatPolicyGateDecision, formatProjectJudgmentCard, formatStuckGuardDecision, getAutomationManifestPath, getAutomationStatus, getCollaborationStatePath, getConfigPath, getContextPackStoragePaths, getLocalCodeOverlayCachePath, getLocalCodePromotionStatePath, getOrchestratorRecommendation, getPlanStepDisplayTitle, getStagedFiles, getStuckGuardInjection, getTeamSyncStatePath, ingestReferences, installAutomationBundle, listProjectsForApiKey, loadAutomationManifest, loadCollaborationState, loadConfig, loadTeamSyncState, memoryAuditCommand, memoryCleanCandidatesCommand, memoryCompactCommand, memoryHealthCommand, memoryLocalCommand, normalizeCollaborationFiles, normalizeGuardTag, normalizeWorkflowPlanInput, packContext, parseCollaborationResources, projectIntelligenceBriefCommand, projectIntelligenceRunCommand, readLocalCodeOverlayCache, readLocalCodePromotionState, referencesIngestCommand, referencesScanCommand, resolveContextPackRecord, resolveFullWorkflowTokenBudget, resolveQueryFromToolInput, retrieveContextPack, runMemoryGuardCheck, saveCollaborationState, saveConfig, saveTeamSyncState, scanReferences, shouldSuggestOrchestratorForWorkflow, shouldSuggestRuntimeForWorkflow, summarizeLocalCodeOverlay, teamSyncSweepCommand, validatePlanResult, verifyCommand, writeLocalCodeOverlayCache, writeLocalCodePromotionState, writeOrchestratorHandoff };