Skip to content
Generated from the .d.ts files published in guardlink@2.7.1. Report problems against guardlink, not this page.

API reference

Every export of guardlink@2.7.1, generated from the .d.ts files in the published package.

The declarations are the contract: they are what a consumer’s compiler reads, and they can differ from the TypeScript source in both directions. Nothing on these pages is derived from source.

The package declares 12 subpath exports. Anything you reach by a deeper path is internal and outside the semver contract.

Import Declarations Documented at
guardlink dist/index.d.ts guardlink
guardlink/parser dist/parser/index.d.ts guardlink
guardlink/structure dist/structure/index.d.ts structure
guardlink/init dist/init/index.d.ts init
guardlink/report dist/report/index.d.ts report
guardlink/diff dist/diff/index.d.ts diff
guardlink/blame dist/blame/index.d.ts blame
guardlink/hypothesis dist/hypothesis/index.d.ts hypothesis
guardlink/analyzer dist/analyzer/index.d.ts analyzer
guardlink/attest dist/attest/index.d.ts attest
guardlink/bom dist/bom/index.d.ts guardlink
guardlink/mcp dist/mcp/index.d.ts mcp

2 of these specifiers declare nothing of their own. Every name below is documented on the guardlink page, and importing it from either path gives you the same value. They have no page of their own because a page per name saying “re-exported from the root” is a click that answers nothing.

guardlink/parser re-exports 118:

ACCEPTANCE_REGISTER_ID, ACCEPTANCE_REGISTER_NOTE, ACCEPTANCE_REGISTER_SHORT, ANCHOR_HASH_VERSION, ANNOTATIONS_DIR, ANNOTATION_HASH_VERSION, CROSS_REPO_TAG_PATTERN, DEFAULT_ACCEPTANCE_POLICY, DEFAULT_ACCEPTANCE_WARN_DAYS, DEFAULT_SECURITY_TESTS_DIR, DEMOTABLE_VERBS, GAL_CONVENTION, HANDOFF_COMMAND, HANDOFF_PATH, LEDGER_FILE, LEDGER_SCHEMA, MAX_ACCEPTANCE_WARN_DAYS, MUTATING_EFFECTS, REACH_ANALYSIS_VERSION, SecurityTestsConfigError, WORKLIST_SCHEMA, acceptanceBlastRadius, acceptanceCovers, acceptanceDefects, actorResolver, annotationLineRoles, annotationScope, annotationsLeftBehind, applyAnnotations, applyReanchor, applyVerification, boundCode, buildAnnotationWorklist, buildCoverageIndex, buildReachAnalysis, buildRouteIndex, canEntitlementDemote, canonicalAnchorRecords, canonicalAnnotationRecords, checkHandoff, citationMatchesFile, claimText, classifyClaims, classifyEffects, clearAnnotations, commentStyleForExt, compileScopePattern, computeAnchorHash, computeAnnotationHash, countAnchors, coversExposure, crossRepoTag, daysRemaining, defaultVerifier, demotionSet, emptyLedger, entitlementDemotionBlockers, extractCitation, filterByFeature, findAcceptanceDefects, findAcceptedExposures, findAcceptedWithoutAudit, findAgentConfigDiagnostics, findAgentReachConflicts, findAnchorDrift, findDanglingRefs, findExpiringAcceptances, findImpreciseEntitlements, findInertEntitlements, findOffConventionGalFiles, findTicketDiagnostics, findUndeclaredActors, findUnentitledReaches, findUngatedEffects, findUnmitigatedExposures, findUnresolvedBoundarySides, formatBlastRadius, galPathFor, getFeatureSummaries, handlerScope, hasReachClaims, headCommit, isConventionalGalPath, isExpired, isMutatingEffect, isQualified, listFeatures, lostAnchors, migrateAnnotationMode, normalizeName, normalizeRef, nowIso, parseExpiry, parseFile, parseLine, parseProject, parseRouteChannel, parseString, planVerification, reachKey, readAcceptancePolicy, readGalBlocks, readLedger, readScopeConfig, readSecurityTestsDir, relationRecords, resolveGalPath, resolveSeverity, scopeEncloses, serializeLedger, sourceFileForGal, stripCommentPrefix, ticketStatusResolver, ticketsForResolver, todayISO, unescapeDescription, withReachAnalysis, writeLedger

guardlink/bom re-exports 1:

generateAiBom

Terminal window
npm install guardlink@2.7.1

Pinned at npm guardlink@2.7.1. The command-line surface of the same package is at CLI reference, and the tools its MCP server registers are at MCP tool reference.