snipara-companion 3.2.3 → 3.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -0
- package/dist/index.d.ts +32 -1
- package/dist/index.js +1618 -661
- package/docs/FULL_REFERENCE.md +43 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -56,6 +56,51 @@ These commands are useful without hosted Snipara:
|
|
|
56
56
|
| `intelligence ledger-export` | Structured redacted ledger JSON for replay and review |
|
|
57
57
|
| `stuck-guard`, `memory-guard`, `pre-tool`, `post-tool` | Fail-soft local guards and hook helpers |
|
|
58
58
|
|
|
59
|
+
### Local Worker Registry
|
|
60
|
+
|
|
61
|
+
Use `workers local` when you want Companion to route bounded work to a local
|
|
62
|
+
OpenAI-compatible runtime such as LM Studio. The registry is project state under
|
|
63
|
+
`.snipara/workers/`; commit intentional profile changes like any other
|
|
64
|
+
workflow artifact. Keep API keys, tokens, passwords, and private credentialed
|
|
65
|
+
URLs out of worker profiles. Use environment variables for credentials.
|
|
66
|
+
|
|
67
|
+
Probe the local runtime first:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx -y snipara-companion workers local probe \
|
|
71
|
+
--base-url http://127.0.0.1:1234 \
|
|
72
|
+
--model openai/gpt-oss-20b \
|
|
73
|
+
--role documentation \
|
|
74
|
+
--capability docs_write \
|
|
75
|
+
--write-scope packages/cli/README.md
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Declare the worker only after the probe matches the intended model and scope:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
npx -y snipara-companion workers local add \
|
|
82
|
+
--id local-openai-gpt-oss-20b \
|
|
83
|
+
--base-url http://127.0.0.1:1234 \
|
|
84
|
+
--model openai/gpt-oss-20b \
|
|
85
|
+
--role documentation \
|
|
86
|
+
--capability docs_write \
|
|
87
|
+
--write-scope packages/cli/README.md
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Inspect declared workers before routing:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
npx -y snipara-companion workers local list
|
|
94
|
+
npx -y snipara-companion workers local status --json
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Remove stale local profiles when a model, endpoint, or write scope is no longer
|
|
98
|
+
valid:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
npx -y snipara-companion workers local remove local-openai-gpt-oss-20b
|
|
102
|
+
```
|
|
103
|
+
|
|
59
104
|
## Agent Continuity
|
|
60
105
|
|
|
61
106
|
After the first impact check, keep the work resumable:
|
package/dist/index.d.ts
CHANGED
|
@@ -3550,9 +3550,11 @@ interface LocalWorkerDeclaration {
|
|
|
3550
3550
|
endpointType: "local";
|
|
3551
3551
|
provider: string;
|
|
3552
3552
|
baseUrl: string;
|
|
3553
|
+
command?: string;
|
|
3553
3554
|
model?: string;
|
|
3554
3555
|
preferModel?: string;
|
|
3555
3556
|
capabilities: string[];
|
|
3557
|
+
reasoning: "low" | "medium" | "high";
|
|
3556
3558
|
writeScope: string[];
|
|
3557
3559
|
createdAt: string;
|
|
3558
3560
|
updatedAt: string;
|
|
@@ -3584,14 +3586,41 @@ interface LocalWorkerAddOptions {
|
|
|
3584
3586
|
preferModel?: string;
|
|
3585
3587
|
capabilities?: string[];
|
|
3586
3588
|
writeScope?: string[];
|
|
3589
|
+
contextWindow?: number;
|
|
3590
|
+
reasoning?: "low" | "medium" | "high";
|
|
3587
3591
|
default?: boolean;
|
|
3588
3592
|
json?: boolean;
|
|
3593
|
+
transport?: "openai_http" | "cli";
|
|
3594
|
+
command?: string;
|
|
3589
3595
|
}
|
|
3590
3596
|
interface LocalWorkerStatusOptions {
|
|
3591
3597
|
json?: boolean;
|
|
3592
3598
|
}
|
|
3599
|
+
interface LocalWorkerListOptions {
|
|
3600
|
+
json?: boolean;
|
|
3601
|
+
}
|
|
3602
|
+
interface LocalWorkerRemoveOptions {
|
|
3603
|
+
id: string;
|
|
3604
|
+
json?: boolean;
|
|
3605
|
+
}
|
|
3606
|
+
interface LocalWorkerProbeOptions {
|
|
3607
|
+
baseUrl?: string;
|
|
3608
|
+
provider?: string;
|
|
3609
|
+
model?: string;
|
|
3610
|
+
preferModel?: string;
|
|
3611
|
+
role?: string;
|
|
3612
|
+
workerId?: string;
|
|
3613
|
+
capabilities?: string[];
|
|
3614
|
+
writeScope?: string[];
|
|
3615
|
+
reasoning?: "low" | "medium" | "high";
|
|
3616
|
+
contextWindow?: number;
|
|
3617
|
+
json?: boolean;
|
|
3618
|
+
}
|
|
3593
3619
|
declare function workersLocalAddCommand(options: LocalWorkerAddOptions): void;
|
|
3594
3620
|
declare function workersLocalStatusCommand(options?: LocalWorkerStatusOptions): void;
|
|
3621
|
+
declare function workersLocalListCommand(options?: LocalWorkerListOptions): void;
|
|
3622
|
+
declare function workersLocalRemoveCommand(options: LocalWorkerRemoveOptions): void;
|
|
3623
|
+
declare function workersLocalProbePrintCommand(options: LocalWorkerProbeOptions): void;
|
|
3595
3624
|
declare function addLocalWorker(options: LocalWorkerAddOptions): {
|
|
3596
3625
|
worker: LocalWorkerDeclaration;
|
|
3597
3626
|
config: LocalWorkersConfig;
|
|
@@ -4077,6 +4106,7 @@ interface AdaptiveRoutingCard {
|
|
|
4077
4106
|
costEstimate: AdaptiveRoutingCostEstimate;
|
|
4078
4107
|
humanApprovalRequired: boolean;
|
|
4079
4108
|
fallback: "main_agent";
|
|
4109
|
+
rejectedReasons?: Record<string, string[]>;
|
|
4080
4110
|
reasons: string[];
|
|
4081
4111
|
warnings: string[];
|
|
4082
4112
|
}
|
|
@@ -4108,6 +4138,7 @@ interface AdaptiveRoutingResolution {
|
|
|
4108
4138
|
fallback?: string;
|
|
4109
4139
|
reasons?: string[];
|
|
4110
4140
|
warnings?: string[];
|
|
4141
|
+
rejectedReasons?: Record<string, string[]>;
|
|
4111
4142
|
}
|
|
4112
4143
|
interface AdaptiveWorkRoutingRecommendation {
|
|
4113
4144
|
workProfile: AdaptiveWorkProfile;
|
|
@@ -4224,4 +4255,4 @@ declare function buildOrchestratorHandoff(options: OrchestratorHandoffOptions):
|
|
|
4224
4255
|
declare function buildAdaptiveWorkRoutingRecommendation(options: AdaptiveWorkRoutingOptions): AdaptiveWorkRoutingRecommendation;
|
|
4225
4256
|
declare function writeOrchestratorHandoff(options: OrchestratorHandoffOptions): WrittenOrchestratorHandoff;
|
|
4226
4257
|
|
|
4227
|
-
export { AUTOMATION_MANIFEST_RELATIVE_PATH, AutomationInstallConflictError, AutomationUnsupportedHookBundleError, CODING_INTELLIGENCE_LEDGER_VERSION, COLLABORATION_STATE_RELATIVE_PATH, ENGINEERING_LEAD_EXECUTION_RECEIPT_STAGES, ENGINEERING_LEAD_EXECUTION_RECEIPT_STATUSES, ENGINEERING_LEAD_POSTURES, ENGINEERING_LEAD_PROOF_VERIFICATION_SOURCES, ENGINEERING_LEAD_PROOF_VERIFICATION_STATUSES, ENGINEERING_LEAD_ROUTING_MODES, ENGINEERING_LEAD_STATUSES, ENGINEERING_LEAD_SUPERVISION_STATUSES, ENGINEERING_LEAD_WORKER_ROLES, ENGINEERING_LEAD_WORK_PACKAGE_STATUSES, ORCHESTRATOR_HANDOFF_RELATIVE_PATH, PRODUCER_LOOP_ARTIFACT_VERSION, PRODUCER_LOOP_RELATIVE_DIR, PRODUCER_LOOP_REPORT_VERSION, TEAM_SYNC_STATE_RELATIVE_PATH, WHY_OUTCOME_CAPTURE_VERSION, WORKFLOW_PLANS_RELATIVE_DIR, WORKFLOW_STATE_RELATIVE_PATH, addLocalWorker, agentReadinessAuditCommand, appendActivityEvent, archiveInactiveTeamSyncWork, attachLocalContextPackReceipts, autoArchiveTeamSyncState, buildAdaptiveWorkRoutingRecommendation, buildAgentReadinessAuditReport, buildAgenticHandoffMarkdown, buildAgenticTimeline, buildAgenticWorkStatus, buildAutomationInstallPlan, buildCanonicalEvent, buildCodeHooksInstallPlan, buildCodePromotionResult, buildCodeStatusResult, buildCodeSyncResult, buildCodingIntelligenceLedger, buildCollaborationActor, buildCollaborationGuardActionCards, buildCollaborationHooksInstallPlan, buildCompanionEngineeringLeadPlanReport, buildContextPackStats, buildEvalCaseArtifact, buildGeneratedWorkflowPlanDocument, buildHostedCodeOverlayUploadPayload, buildHostedGuardPayload, buildJournalCheckpointEntry, buildLocalCallersResult, buildLocalCodeOverlay, buildLocalContextPackReceipt, buildLocalContextPackReceipts, buildLocalImpactResult, buildLocalImportsResult, buildLocalNeighborsResult, buildLocalProjectRealityCheck, buildLocalShortestPathResult, buildLocalSourceSnapshot, buildLocalSourceStatus, buildLocalSourceSyncResult, buildMemoryAudit, buildOnboardFolderManifest, buildOrchestratorHandoff, buildProducerLoopReport, buildProjectIntelligenceBrief, buildProjectIntelligenceRun, buildProjectJudgmentCard, buildSessionBootstrapQuality, buildSessionSnapshot, buildSyncDocumentsDryRun, buildTeamSyncHandoffRecord, buildTeamSyncStartWorkRecord, buildTeamSyncSummary, buildToolCallPayload, buildToolResultPayload, buildVerificationPlan, buildWhyOutcomeCaptureReport, buildWorkflowImpactGate, buildWorkflowPhaseCommitSummary, buildWorkflowPlanScaffold, categoryFromGuardTag, classifyToolResult, cleanContextPacks, codingLedgerExportCommand, collaborationIdeStatusCommand, collectAgentReadinessLocalSignals, collectSyncDocuments, collectSyncDocumentsInput, compactHostedGuardResources, compareLocalSourceSnapshots, completeTeamSyncStateFromEvidence, completeTeamSyncWorkFromEvidence, contextPackCleanCommand, contextPackPackCommand, contextPackRetrieveCommand, contextPackStatsCommand, createClient, createEmptyCollaborationState, createEmptyTeamSyncState, createLocalQueryCache, deriveLocalCollaborationResourcesFromFiles, detectReleaseSurfacesFromFiles, detectRuntimeEnvironment, evalExportCommand, evalRunCommand, evaluateProjectPolicyGates, extractCommandFromToolInput, extractFilesFromToolInput, formatAgentReadinessAuditReport, formatCompanionEngineeringLeadPlanReport, formatOrchestratorRecommendationReason, formatPolicyGateDecision, formatProjectJudgmentCard, formatStuckGuardDecision, getAutomationManifestPath, getAutomationStatus, getCollaborationStatePath, getConfigPath, getContextPackStoragePaths, getLocalCodeOverlayCachePath, getLocalCodePromotionStatePath, getLocalSourceSnapshotPath, getOrchestratorRecommendation, getPlanStepDisplayTitle, getStagedFiles, getStuckGuardInjection, getTeamSyncStatePath, ingestReferences, installAutomationBundle, leadPlanCommand, listProjectsForApiKey, loadAutomationManifest, loadCollaborationState, loadConfig, loadTeamSyncState, memoryAuditCommand, memoryCleanCandidatesCommand, memoryCompactCommand, memoryHealthCommand, memoryLocalCommand, memoryReviewsCommand, normalizeCollaborationFiles, normalizeGuardTag, normalizeWorkflowPlanInput, outcomeCapturePreviewCommand, packContext, parseCollaborationResources, projectIntelligenceBriefCommand, projectIntelligenceRunCommand, readActivityTimeline, readLocalCodeOverlayCache, readLocalCodePromotionState, readLocalSourceSnapshot, readLocalWorkersConfig, readSessionSnapshot, realityCheckCommand, referencesIngestCommand, referencesScanCommand, resolveContextPackRecord, resolveFullWorkflowTokenBudget, resolveLocalWorkerRoutingDefaults, resolveQueryFromToolInput, retrieveContextPack, runMemoryGuardCheck, saveCollaborationState, saveConfig, saveTeamSyncState, scanReferences, shouldSuggestOrchestratorForWorkflow, shouldSuggestRuntimeForWorkflow, summarizeLocalCodeOverlay, teamSyncSweepCommand, validatePlanResult, verifyCommand, workersLocalAddCommand, workersLocalStatusCommand, writeLocalCodeOverlayCache, writeLocalCodePromotionState, writeLocalSourceSnapshot, writeOrchestratorHandoff, writeProducerLoopArtifact, writeSessionSnapshot };
|
|
4258
|
+
export { AUTOMATION_MANIFEST_RELATIVE_PATH, AutomationInstallConflictError, AutomationUnsupportedHookBundleError, CODING_INTELLIGENCE_LEDGER_VERSION, COLLABORATION_STATE_RELATIVE_PATH, ENGINEERING_LEAD_EXECUTION_RECEIPT_STAGES, ENGINEERING_LEAD_EXECUTION_RECEIPT_STATUSES, ENGINEERING_LEAD_POSTURES, ENGINEERING_LEAD_PROOF_VERIFICATION_SOURCES, ENGINEERING_LEAD_PROOF_VERIFICATION_STATUSES, ENGINEERING_LEAD_ROUTING_MODES, ENGINEERING_LEAD_STATUSES, ENGINEERING_LEAD_SUPERVISION_STATUSES, ENGINEERING_LEAD_WORKER_ROLES, ENGINEERING_LEAD_WORK_PACKAGE_STATUSES, ORCHESTRATOR_HANDOFF_RELATIVE_PATH, PRODUCER_LOOP_ARTIFACT_VERSION, PRODUCER_LOOP_RELATIVE_DIR, PRODUCER_LOOP_REPORT_VERSION, TEAM_SYNC_STATE_RELATIVE_PATH, WHY_OUTCOME_CAPTURE_VERSION, WORKFLOW_PLANS_RELATIVE_DIR, WORKFLOW_STATE_RELATIVE_PATH, addLocalWorker, agentReadinessAuditCommand, appendActivityEvent, archiveInactiveTeamSyncWork, attachLocalContextPackReceipts, autoArchiveTeamSyncState, buildAdaptiveWorkRoutingRecommendation, buildAgentReadinessAuditReport, buildAgenticHandoffMarkdown, buildAgenticTimeline, buildAgenticWorkStatus, buildAutomationInstallPlan, buildCanonicalEvent, buildCodeHooksInstallPlan, buildCodePromotionResult, buildCodeStatusResult, buildCodeSyncResult, buildCodingIntelligenceLedger, buildCollaborationActor, buildCollaborationGuardActionCards, buildCollaborationHooksInstallPlan, buildCompanionEngineeringLeadPlanReport, buildContextPackStats, buildEvalCaseArtifact, buildGeneratedWorkflowPlanDocument, buildHostedCodeOverlayUploadPayload, buildHostedGuardPayload, buildJournalCheckpointEntry, buildLocalCallersResult, buildLocalCodeOverlay, buildLocalContextPackReceipt, buildLocalContextPackReceipts, buildLocalImpactResult, buildLocalImportsResult, buildLocalNeighborsResult, buildLocalProjectRealityCheck, buildLocalShortestPathResult, buildLocalSourceSnapshot, buildLocalSourceStatus, buildLocalSourceSyncResult, buildMemoryAudit, buildOnboardFolderManifest, buildOrchestratorHandoff, buildProducerLoopReport, buildProjectIntelligenceBrief, buildProjectIntelligenceRun, buildProjectJudgmentCard, buildSessionBootstrapQuality, buildSessionSnapshot, buildSyncDocumentsDryRun, buildTeamSyncHandoffRecord, buildTeamSyncStartWorkRecord, buildTeamSyncSummary, buildToolCallPayload, buildToolResultPayload, buildVerificationPlan, buildWhyOutcomeCaptureReport, buildWorkflowImpactGate, buildWorkflowPhaseCommitSummary, buildWorkflowPlanScaffold, categoryFromGuardTag, classifyToolResult, cleanContextPacks, codingLedgerExportCommand, collaborationIdeStatusCommand, collectAgentReadinessLocalSignals, collectSyncDocuments, collectSyncDocumentsInput, compactHostedGuardResources, compareLocalSourceSnapshots, completeTeamSyncStateFromEvidence, completeTeamSyncWorkFromEvidence, contextPackCleanCommand, contextPackPackCommand, contextPackRetrieveCommand, contextPackStatsCommand, createClient, createEmptyCollaborationState, createEmptyTeamSyncState, createLocalQueryCache, deriveLocalCollaborationResourcesFromFiles, detectReleaseSurfacesFromFiles, detectRuntimeEnvironment, evalExportCommand, evalRunCommand, evaluateProjectPolicyGates, extractCommandFromToolInput, extractFilesFromToolInput, formatAgentReadinessAuditReport, formatCompanionEngineeringLeadPlanReport, formatOrchestratorRecommendationReason, formatPolicyGateDecision, formatProjectJudgmentCard, formatStuckGuardDecision, getAutomationManifestPath, getAutomationStatus, getCollaborationStatePath, getConfigPath, getContextPackStoragePaths, getLocalCodeOverlayCachePath, getLocalCodePromotionStatePath, getLocalSourceSnapshotPath, getOrchestratorRecommendation, getPlanStepDisplayTitle, getStagedFiles, getStuckGuardInjection, getTeamSyncStatePath, ingestReferences, installAutomationBundle, leadPlanCommand, listProjectsForApiKey, loadAutomationManifest, loadCollaborationState, loadConfig, loadTeamSyncState, memoryAuditCommand, memoryCleanCandidatesCommand, memoryCompactCommand, memoryHealthCommand, memoryLocalCommand, memoryReviewsCommand, normalizeCollaborationFiles, normalizeGuardTag, normalizeWorkflowPlanInput, outcomeCapturePreviewCommand, packContext, parseCollaborationResources, projectIntelligenceBriefCommand, projectIntelligenceRunCommand, readActivityTimeline, readLocalCodeOverlayCache, readLocalCodePromotionState, readLocalSourceSnapshot, readLocalWorkersConfig, readSessionSnapshot, realityCheckCommand, referencesIngestCommand, referencesScanCommand, resolveContextPackRecord, resolveFullWorkflowTokenBudget, resolveLocalWorkerRoutingDefaults, resolveQueryFromToolInput, retrieveContextPack, runMemoryGuardCheck, saveCollaborationState, saveConfig, saveTeamSyncState, scanReferences, shouldSuggestOrchestratorForWorkflow, shouldSuggestRuntimeForWorkflow, summarizeLocalCodeOverlay, teamSyncSweepCommand, validatePlanResult, verifyCommand, workersLocalAddCommand, workersLocalListCommand, workersLocalProbePrintCommand, workersLocalRemoveCommand, workersLocalStatusCommand, writeLocalCodeOverlayCache, writeLocalCodePromotionState, writeLocalSourceSnapshot, writeOrchestratorHandoff, writeProducerLoopArtifact, writeSessionSnapshot };
|