Skip to main content

Functions & Classes

SymbolKindDescription
getPlatformPaths()functionGet OS-appropriate paths for CAAMP’s global directories.
getSystemInfo()functionGet a cached system information snapshot.
_resetPlatformPathsCache()functionInvalidate the path and system info caches. Use in tests after mutating AGENT…
getPlatformLocations()functionResolves platform-specific directory locations for the current OS.
getAgentsHome()functionReturns the global agents home directory path.
getProjectAgentsDir()functionReturns the project-local .agents directory path.
resolveProjectPath()functionResolves a relative path against a project directory.
getCanonicalSkillsDir()functionReturns the canonical skills storage directory path.
getLockFilePath()functionReturns the path to the CAAMP lock file.
getAgentsMcpDir()functionGets the MCP directory within the .agents/ standard structure.
getAgentsMcpServersPath()functionGets the MCP servers.json path within the .agents/ standard structure.
getAgentsInstructFile()functionGets the primary AGENTS.md instruction file path within .agents/.
getAgentsConfigPath()functionGets the config.toml path within the .agents/ standard structure.
getAgentsWikiDir()functionGets the wiki directory within the .agents/ standard structure.
getAgentsSpecDir()functionGets the spec directory within the .agents/ standard structure.
getAgentsLinksDir()functionGets the links directory within the .agents/ standard structure.
resolveRegistryTemplatePath()functionResolves a registry template path by substituting platform variables.
resolveProviderConfigPath()functionResolves the configuration file path for a provider at the given scope.
resolvePreferredConfigScope()functionDetermines the preferred configuration scope for a provider.
resolveProviderSkillsDir()functionResolves the skills directory path for a provider at the given scope.
resolveProviderSkillsDirs()functionGets all target directories for skill installation based on provider precedence.
resolveProviderProjectPath()functionResolves a provider’s project-level path against a project directory.
resolveProvidersRegistryPath()functionLocates the providers registry.json file by searching up from a start directory.
normalizeSkillSubPath()functionNormalizes a skill sub-path by cleaning separators and removing SKILL.md suffix.
buildSkillSubPathCandidates()functionBuilds a list of candidate sub-paths for skill file resolution.
getAllProviders()functionRetrieve all registered providers with resolved platform paths. Providers ar…
getProvider()functionLook up a provider by its ID or any of its aliases.
resolveAlias()functionResolve an alias to its canonical provider ID. If the input is already a can…
getProvidersByPriority()functionFilter providers by their priority tier.
getPrimaryProvider()functionGet the single primary harness provider, if any is registered.
getProvidersByStatus()functionFilter providers by their lifecycle status.
getProvidersByInstructFile()functionFilter providers that use a specific instruction file. Multiple providers of…
getInstructionFiles()functionGet the set of all unique instruction file names across all providers.
getProviderCount()functionGet the total number of registered providers.
getRegistryVersion()functionGet the semantic version string of the provider registry.
getProvidersByHookEvent()functionFilter providers that support a specific hook event.
getCommonHookEvents()functionGet hook events common to all specified providers. If providerIds is provide…
providerSupports()functionCheck whether a provider supports a specific capability via dot-path query…
getSpawnCapableProviders()functionFilter providers that support spawning subagents.
getProvidersBySpawnCapability()functionFilter providers by a specific boolean spawn capability flag.
resetRegistry()functionReset cached registry data, forcing a reload on next access.
getProvidersBySkillsPrecedence()functionFilter providers by their skills precedence value.
getEffectiveSkillsPaths()functionGet the effective skills paths for a provider, ordered by precedence.
buildSkillsMap()functionBuild a full skills map for all providers.
getProviderCapabilities()functionGet capabilities for a provider by ID or alias.
providerSupportsById()functionCheck if a provider supports a capability using ID/alias lookup. Convenience…
buildInjectionContent()functionBuild injection content from a structured template. Produces a string suitab…
parseInjectionContent()functionParse injection content back into template form. Lines starting with @ are…
generateInjectionContent()functionGenerate a standard CAAMP injection block for instruction files. Produces ma…
generateSkillsSection()functionGenerate a skills discovery section for instruction files.
getInstructFile()functionGet the correct instruction file name for a provider.
groupByInstructFile()functionGroup providers by their instruction file name. Useful for determining which…
checkInjection()functionCheck the status of a CAAMP injection block in an instruction file. Returns…
inject()functionInject content into an instruction file between CAAMP markers. Behavior depe…
removeInjection()functionRemove the CAAMP injection block from an instruction file. If removing the b…
checkAllInjections()functionCheck injection status across all providers’ instruction files. Deduplicates…
injectAll()functionInject content into all providers’ instruction files. Deduplicates by file p…
ensureProviderInstructionFile()functionEnsure a provider’s instruction file exists with the correct CAAMP block. Th…
ensureAllProviderInstructionFiles()functionEnsure instruction files for multiple providers at once. Deduplicates by fil…
setVerbose()functionEnable or disable verbose (debug) logging mode. When enabled, debug messages…
setQuiet()functionEnable or disable quiet mode. When enabled, info and warning messages are su…
debug()functionLog a debug message to stderr when verbose mode is enabled.
info()functionLog an informational message to stdout.
warn()functionLog a warning message to stderr.
error()functionLog an error message to stderr.
isVerbose()functionCheck if verbose (debug) logging is currently enabled.
isQuiet()functionCheck if quiet mode is currently enabled.
setHuman()functionEnable or disable human-readable output mode. When enabled, commands output…
isHuman()functionCheck if human-readable output mode is currently enabled.
detectProvider()functionDetect if a single provider is installed on the system. Checks each detectio…
detectProjectProvider()functionDetect if a provider has project-level config in the given directory.
detectAllProviders()functionDetect all registered providers and return their installation status. Runs d…
getInstalledProviders()functionGet only providers that are currently installed on the system. Convenience w…
detectProjectProviders()functionDetect all providers and enrich results with project-level presence. Extends…
resetDetectionCache()functionReset the detection result cache, forcing fresh detection on next call.
installToCanonical()functionCopy skill files to the canonical location.
installSkill()functionInstall a skill from a local path to the canonical location and link to agents.
removeSkill()functionRemove a skill from the canonical location and all agent symlinks.
listCanonicalSkills()functionList all skills installed in the canonical skills directory.
selectProvidersByMinimumPriority()functionFilters providers by minimum priority and returns them in deterministic tier…
installBatchWithRollback()functionInstalls multiple skills across filtered providers with rollback.
updateInstructionsSingleOperation()functionUpdates instruction files across providers as a single operation.
resolveFormat()functionResolves output format based on flags and defaults.
buildEnvelope()functionBuilds a standard LAFS envelope.
emitError()functionEmits a JSON error envelope to stderr and exits the process.
emitJsonError()functionEmits a JSON error envelope without exiting (for catch blocks).
outputSuccess()functionOutputs a successful LAFS envelope to stdout.
handleFormatError()functionHandles format resolution errors consistently.
LAFSCommandErrorclassStructured error class for LAFS-compliant command failures with error codes a…
emitSuccess()functionEmits a successful LAFS result envelope to stdout.
emitError()functionEmits a failed LAFS error envelope to stderr.
runLafsCommand()functionRuns an async action and emits the result as a LAFS success or error envelope.
parsePriority()functionParses and validates a provider priority tier string.
resolveProviders()functionResolves the set of target providers from CLI targeting options.
readJsonFile()functionReads and parses a JSON file from disk.
readSkillOperations()functionReads and validates a JSON file containing skill batch operations.
readTextInput()functionReads text input from either inline content or a file path, enforcing mutual…
registerAdvancedBatch()functionRegisters the advanced batch subcommand for rollback-capable batch install…
registerAdvancedInstructions()functionRegisters the advanced instructions subcommand for single-operation instruc…
registerAdvancedProviders()functionRegisters the advanced providers subcommand for selecting providers by prio…
registerAdvancedCommands()functionRegisters the advanced command group with providers, batch, and instruction…
deepMerge()functionDeep merge two objects, with source values winning on conflict. Recursivel…
setNestedValue()functionSet a nested value using a dot-notation key path.
getNestedValue()functionGet a nested value from an object using a dot-notation key path.
ensureDir()functionEnsure that the parent directories of a file path exist. Creates directories…
readJsonConfig()functionRead and parse a JSON or JSONC config file.
writeJsonConfig()functionWrite a server config entry to a JSON/JSONC file, preserving comments.
removeJsonConfig()functionRemove a server entry from a JSON/JSONC config file.
readTomlConfig()functionRead and parse a TOML config file.
writeTomlConfig()functionWrite a server config entry to a TOML file.
removeTomlConfig()functionRemove a server entry from a TOML config file.
readYamlConfig()functionRead and parse a YAML config file.
writeYamlConfig()functionWrite a server config entry to a YAML file.
removeYamlConfig()functionRemove a server entry from a YAML config file.
readConfig()functionRead and parse a config file in the specified format. Dispatches to the appr…
writeConfig()functionWrite a server entry to a config file, preserving existing content. Dispatch…
removeConfig()functionRemove a server entry from a config file in the specified format.
registerConfigCommand()functionRegisters the config command group with show and path subcommands for viewi…
readLockFile()functionRead and parse the CAAMP lock file from disk.
writeLockFile()functionWrite the lock file atomically under a process lock guard.
updateLockFile()functionSafely read-modify-write the lock file under a process lock guard.
getCaampVersion()functionRetrieve the current CAAMP package version from the nearest package.json.
registerDoctorCommand()functionRegisters the doctor command for diagnosing configuration issues and overal…
registerInstructionsCheck()functionRegisters the instructions check subcommand for verifying injection status…
registerInstructionsInject()functionRegisters the instructions inject subcommand for injecting instruction bloc…
registerInstructionsUpdate()functionRegisters the instructions update subcommand for refreshing all instruction…
registerInstructionsCommands()functionRegisters the instructions command group with inject, check, and update sub…
resetHookMappings()functionReset the cached hook mappings data.
getCanonicalEvent()functionGet the canonical event definition (category, description, canBlock).
getAllCanonicalEvents()functionGet all canonical event definitions.
getCanonicalEventsByCategory()functionGet canonical events filtered by category.
getProviderHookProfile()functionGet the full hook profile for a provider.
getMappedProviderIds()functionGet all provider IDs that have hook mappings.
toNative()functionTranslate a CAAMP canonical event name to the provider’s native name.
toCanonical()functionTranslate a provider-native event name to the CAAMP canonical name.
toNativeBatch()functionBatch-translate multiple canonical events to native names for a provider.
supportsHook()functionCheck if a provider supports a specific canonical hook event.
getHookSupport()functionGet full hook support details for a canonical event on a provider.
getSupportedEvents()functionGet all supported canonical events for a provider.
getUnsupportedEvents()functionGet all unsupported canonical events for a provider.
getProvidersForEvent()functionGet providers that support a specific canonical event.
getCommonEvents()functionGet canonical events common to all specified providers.
getProviderSummary()functionGet a summary of hook support for a provider.
buildHookMatrix()functionBuild a cross-provider hook support matrix.
getHookSystemType()functionGet the hook system type for a provider.
getHookConfigPath()functionGet the resolved hook config path for a provider.
getProviderOnlyEvents()functionGet provider-only events (native events with no canonical mapping).
translateToAll()functionTranslate a canonical event to native names across multiple providers.
resolveNativeEvent()functionFind the best canonical match for a native event name across all providers.
getHookMappingsVersion()functionGet the version of the hook mappings data.
registerProvidersCommand()functionRegisters the providers command group with list, detect, show, skills-map,…
getRulesByCategory()functionGet audit rules filtered by category.
getRulesBySeverity()functionGet audit rules filtered by severity level.
getCategories()functionGet all unique rule categories.
scanFile()functionScan a single file against security audit rules.
scanDirectory()functionScan a directory of skills for security issues.
toSarif()functionConvert audit results to SARIF 2.1.0 format (Static Analysis Results Intercha…
registerSkillsAudit()functionRegisters the skills audit subcommand for security scanning skill files.
parseSource()functionParse and classify a source string into a typed ParsedSource.
isMarketplaceScoped()functionCheck if a source string looks like a marketplace scoped name (@author/name).
recordSkillInstall()functionRecord a skill installation in the lock file.
removeSkillFromLock()functionRemove a skill entry from the lock file.
getTrackedSkills()functionGet all skills tracked in the lock file.
checkSkillUpdate()functionCheck if a skill has updates available by comparing the installed version aga…
checkAllSkillUpdates()functionCheck for updates across all tracked skills.
registerSkillsCheck()functionRegisters the skills check subcommand for checking available skill updates.
NetworkErrorclassStructured error for network failures with categorized kind.
fetchWithTimeout()functionFetch a URL with an automatic timeout via AbortSignal.timeout.
ensureOkResponse()functionAssert that a Response has an OK status, throwing on failure.
formatNetworkError()functionFormat a network error into a user-friendly message string.
SkillsMPAdapterclassMarketplace adapter for the agentskills.in API.
SkillsShAdapterclassMarketplace adapter for the skills.sh API.
MarketplaceUnavailableErrorclassError thrown when all marketplace sources fail to respond.
MarketplaceClientclassUnified marketplace client that aggregates results from multiple marketplace…
tokenizeCriteriaValue()functionSplits a comma-separated criteria string into normalized tokens.
validateRecommendationCriteria()functionValidates recommendation criteria input for correctness and consistency.
normalizeRecommendationCriteria()functionNormalizes raw recommendation criteria into a consistent tokenized form.
scoreSkillRecommendation()functionComputes a recommendation score for a single skill against normalized criteria.
recommendSkills()functionValidates, normalizes, scores, and ranks a list of skills against criteria.
formatSkillRecommendations()functionFormat skill recommendation results for display or serialization.
searchSkills()functionSearch for skills via marketplace APIs.
recommendSkills()functionSearch and rank skills based on query and recommendation criteria.
registerSkillsFind()functionRegisters the skills find subcommand for searching marketplaces and recomme…
registerSkillsInit()functionRegisters the skills init subcommand for scaffolding new SKILL.md templates.
loadLibraryFromModule()functionLoad a SkillLibrary from a module (index.js) at the given root directory.
buildLibraryFromFiles()functionBuild a SkillLibrary from raw files in a directory.
registerSkillLibrary()functionRegisters a SkillLibrary instance directly as the active catalog.
registerSkillLibraryFromPath()functionRegisters a skill library by loading it from a directory path.
clearRegisteredLibrary()functionClears the registered skill library instance.
isCatalogAvailable()functionChecks whether a skill library is available for use.
getSkills()functionReturns all skill entries from the catalog.
getManifest()functionReturns the parsed skill library manifest.
listSkills()functionLists all available skill names in the catalog.
getSkill()functionGets skill metadata by name from the catalog.
getSkillPath()functionResolves the absolute path to a skill’s SKILL.md file.
getSkillDir()functionResolves the absolute path to a skill’s directory.
readSkillContent()functionReads a skill’s SKILL.md content as a string.
getCoreSkills()functionReturns all skills marked as core in the catalog.
getSkillsByCategory()functionReturns skills filtered by category.
getSkillDependencies()functionGets the direct dependency names for a skill.
resolveDependencyTree()functionResolves the full dependency tree for a set of skill names.
listProfiles()functionLists all available profile names in the catalog.
getProfile()functionGets a profile definition by name from the catalog.
resolveProfile()functionResolves a profile to its full skill list including inherited skills.
listSharedResources()functionLists all available shared resource names in the catalog.
getSharedResourcePath()functionGets the absolute path to a shared resource file.
readSharedResource()functionReads a shared resource file’s content as a string.
listProtocols()functionLists all available protocol names in the catalog.
getProtocolPath()functionGets the absolute path to a protocol file.
readProtocol()functionReads a protocol file’s content as a string.
validateSkillFrontmatter()functionValidates a single skill’s frontmatter against the schema.
validateAll()functionValidates all skills in the catalog and returns results per skill.
getDispatchMatrix()functionGets the dispatch matrix from the skill library manifest.
getVersion()functionReturns the skill library version string.
getLibraryRoot()functionReturns the absolute path to the skill library root directory.
parseSkillFile()functionParse a SKILL.md file and extract its frontmatter metadata.
discoverSkill()functionDiscover a single skill at a given directory path.
discoverSkills()functionScan a directory for skill subdirectories, each containing a SKILL.md file.
discoverSkillsMulti()functionDiscover skills across multiple directories.
cloneRepo()functionClone a GitHub repo to a temp directory.
fetchRawFile()functionFetch a specific file from GitHub using the raw API.
repoExists()functionCheck if a GitHub repo exists.
cloneGitLabRepo()functionClone a GitLab repo to a temp directory.
fetchGitLabRawFile()functionFetch a specific file from GitLab using the raw API.
registerSkillsInstall()functionRegisters the skills install subcommand for installing skills from various…
registerSkillsList()functionRegisters the skills list subcommand for listing installed skills.
registerSkillsRemove()functionRegisters the skills remove subcommand for removing installed skills.
registerSkillsUpdate()functionRegisters the skills update subcommand for updating all outdated skills.
validateSkill()functionValidate a SKILL.md file against the Agent Skills standard.
registerSkillsValidate()functionRegisters the skills validate subcommand for validating SKILL.md file format.
registerSkillsCommands()functionRegisters the skills command group with all skill management subcommands.
isCaampOwnedSkill()functionCheck whether a skill name is reserved by CAAMP (ct-* prefix).
checkSkillIntegrity()functionCheck the integrity of a single installed skill.
checkAllSkillIntegrity()functionCheck integrity of all tracked skills.
shouldOverrideSkill()functionResolve a skill name conflict where a user-installed skill collides with a CA…
validateInstructionIntegrity()functionValidate instruction file injection status across all providers.
resolveCantImports()functionResolve *.cant references in instruction file content. Scans each line for…
cantToMarkdown()functionConvert a .cant file’s content to markdown equivalent. Parses the frontmatte…
discoverWellKnown()functionDiscover skills from a well-known URL.

Types & Interfaces

SymbolKindDescription
SkillLibraryEntryinterfaceA single skill entry in a library catalog.
SkillLibraryValidationResultinterfaceValidation result from skill frontmatter validation.
SkillLibraryValidationIssueinterfaceA single validation issue.
SkillLibraryProfileinterfaceProfile definition for grouped skill installation.
SkillLibraryDispatchMatrixinterfaceDispatch matrix for task routing to skills.
SkillLibraryManifestSkillinterfaceSkill entry within the library manifest.
SkillLibraryManifestinterfaceFull manifest structure for a skill library.
SkillLibraryinterfaceStandard interface for a skill library. Any directory or module providing sk…
RegistryDetectioninterfaceRaw detection configuration as stored in registry.json.
ProviderPrioritytypePriority tier identifier stored in registry.json.
ProviderStatustypeLifecycle status identifier stored in registry.json.
RegistryProviderinterfaceRaw provider definition as stored in registry.json before path resolution.
McpConfigFormattypeSupported MCP config file formats.
McpTransportTypetypeMCP transport protocols a provider may advertise.
RegistryMcpIntegrationinterfaceMCP server integration metadata for providers that consume MCP servers via a…
RegistryHarnessKindtypeHarness role category for a primary or standalone harness.
RegistryHarnessCapabilityinterfaceFirst-class harness role declaration.
SkillsPrecedencetypeHow a provider resolves skill file precedence between vendor and agents direc…
RegistrySkillsCapabilityinterfaceRaw skills capability definition as stored in registry.json.
HookEventtypeHook lifecycle event identifier from registry.json.
RegistryHookFormattypeThe on-disk layout of a provider’s hook configuration.
RegistryHookCatalogtypeWhich native event catalog a provider’s hook system uses.
RegistryHooksCapabilityinterfaceRaw hooks capability definition as stored in registry.json.
SpawnMechanismtypeMechanism a provider uses to spawn subagents.
RegistrySpawnCapabilityinterfaceRaw spawn capability definition as stored in registry.json.
RegistryCapabilitiesinterfaceAggregate capability block for a provider in registry.json.
ProviderRegistryinterfaceTop-level structure of the provider registry JSON file.
CtSkillEntrytypeBackward-compatible alias for SkillLibraryEntry.
CtValidationResulttypeBackward-compatible alias for SkillLibraryValidationResult.
CtValidationIssuetypeBackward-compatible alias for SkillLibraryValidationIssue.
CtProfileDefinitiontypeBackward-compatible alias for SkillLibraryProfile.
CtDispatchMatrixtypeBackward-compatible alias for SkillLibraryDispatchMatrix.
CtManifesttypeBackward-compatible alias for SkillLibraryManifest.
CtManifestSkilltypeBackward-compatible alias for SkillLibraryManifestSkill.
ConfigFormattypeSupported configuration file formats. - "json" - Standard JSON - "jsonc"
TransportTypetypeMCP server transport protocol type. - "stdio" - Standard input/output (loc…
DetectionMethodtypeMethod used to detect whether an AI agent is installed on the system. -…
DetectionConfiginterfaceConfiguration for detecting whether a provider is installed.
ProviderMcpCapabilityinterfaceResolved MCP server integration metadata for a provider.
ProviderHarnessCapabilityinterfaceResolved first-class harness capability for a provider.
ProviderSkillsCapabilityinterfaceResolved skills capability for a provider at runtime.
ProviderHooksCapabilityinterfaceResolved hooks capability for a provider at runtime.
ProviderSpawnCapabilityinterfaceResolved spawn capability for a provider at runtime.
ProviderCapabilitiesinterfaceAggregate provider capabilities for MCP, harness role, skills, hooks, and spawn.
ProviderPrioritytypePriority tier for a provider, used for sorting and default selection. -…
ProviderStatustypeLifecycle status of a provider in the registry. - "active" - Fully support…
ProviderinterfaceA resolved AI agent provider definition with platform-specific paths.
McpServerConfiginterfaceCanonical MCP server configuration.
SourceTypetypeClassified type of an MCP server or skill source. - "remote" - HTTP/HTTPS…
ParsedSourceinterfaceResult of parsing a source string into its typed components.
SkillMetadatainterfaceMetadata extracted from a SKILL.md frontmatter.
SkillEntryinterfaceA discovered skill entry with its location and metadata.
LockEntryinterfaceA single entry in the CAAMP lock file tracking an installed skill or MCP server.
CaampLockFileinterfaceThe CAAMP lock file structure, stored at the resolved canonical lock path.
MarketplaceSkillinterfaceA skill listing from a marketplace search result.
MarketplaceSearchResultinterfacePaginated search results from a marketplace API.
AuditSeveritytypeSeverity level for a security audit finding. Ordered from most to least seve…
AuditRuleinterfaceA security audit rule definition with a regex pattern to match against skill…
AuditFindinginterfaceA single finding from a security audit scan, with line-level location.
AuditResultinterfaceAggregate audit result for a single file.
InjectionStatustypeStatus of a CAAMP injection block in an instruction file. - "current" - In…
InjectionCheckResultinterfaceResult of checking a single instruction file for CAAMP injection status.
McpServerEntryinterfaceAn MCP server entry read from a provider’s config file.
GlobalOptionsinterfaceGlobal CLI options shared across all CAAMP commands.
PlatformPathsinterfaceOS-appropriate directory paths for CAAMP’s global storage.
SystemInfointerfaceSnapshot of the current system environment and resolved platform paths.
PathScopetypeScope for path resolution, either global (user home) or project-local.
PlatformLocationsinterfacePlatform-specific directory locations for agent configuration.
InjectionTemplateinterfaceStructured template for injection content.
EnsureProviderInstructionFileOptionsinterfaceOptions for ensuring a provider instruction file.
EnsureProviderInstructionFileResultinterfaceResult of ensuring a provider instruction file.
DetectionResultinterfaceResult of detecting whether a provider is installed on the system.
DetectionCacheOptionsinterfaceOptions for controlling the detection result cache.
SkillInstallResultinterfaceResult of installing a skill to the canonical location and linking to agents.
SkillBatchOperationinterfaceSingle skill operation entry used by batch orchestration.
BatchInstallOptionsinterfaceOptions for rollback-capable batch installation.
BatchInstallResultinterfaceResult of rollback-capable batch installation.
InstructionUpdateSummaryinterfaceResult of a single-operation instruction update across providers.
MVILeveltypeLAFS MVI disclosure level - defined locally to avoid CI module resolution iss…
LAFSErrorShapetypeLAFS Error structure - re-exported from protocol as LAFSErrorShape for CAAMP…
LAFSWarningtypeLAFS Warning structure - re-exported from protocol.
LAFSEnvelopeinterfaceGeneric LAFS Envelope structure for type-safe command results.
FormatOptionsinterfaceFormat resolution options.
LAFSCommandOptionsinterfaceStandard command options interface for LAFS-compliant commands.
ProviderTargetOptionsinterfaceOptions for resolving which providers to target in advanced commands.
HookCategorytypeUnion type of valid hook category strings.
EventSourcetypeUnion type of valid event source types.
CanonicalHookEventtypeUnion type of all canonical hook event names.
CanonicalEventDefinitioninterfaceDefinition of a canonical hook event including its category and behavior.
HookSystemTypetypeThe type of hook system a provider uses.
HookHandlerTypetypeThe mechanism a provider uses to execute hook handlers.
HookMappinginterfaceMapping of a single canonical event to a provider’s native representation.
ProviderHookProfileinterfaceComplete hook profile for a single provider.
NormalizedHookEventinterfaceA fully resolved hook event with both canonical and native names.
HookSupportResultinterfaceResult of querying whether a provider supports a specific canonical event.
ProviderHookSummaryinterfaceAggregated hook support summary for a single provider.
CrossProviderMatrixinterfaceCross-provider hook support matrix comparing multiple providers.
HookMappingsFileinterfaceSchema for the providers/hook-mappings.json data file.
MarketplaceAdapterinterfaceContract that each marketplace backend adapter must implement.
MarketplaceResultinterfaceNormalized marketplace record returned by all adapters.
SearchOptionsinterfaceOptions for marketplace search requests.
RecommendationErrorCodetypeUnion type of all recommendation error code string literals.
RecommendationValidationIssueinterfaceDescribes a single validation issue found in recommendation criteria.
RecommendationValidationResultinterfaceResult of validating recommendation criteria input.
RecommendationCriteriaInputinterfaceRaw user-provided criteria for skill recommendations.
NormalizedRecommendationCriteriainterfaceNormalized and tokenized form of recommendation criteria.
RecommendationReasonCodetypeString literal union of all reason codes emitted during skill scoring.
RecommendationReasoninterfaceA single reason contributing to a skill’s recommendation score.
RecommendationScoreBreakdowninterfaceDetailed breakdown of a skill’s recommendation score by category.
RankedSkillRecommendationinterfaceA single skill recommendation with its computed score and explanations.
RecommendationOptionsinterfaceConfiguration options for the skill recommendation engine.
RecommendationWeightsinterfaceNumeric weights controlling the recommendation scoring algorithm.
RecommendSkillsResultinterfaceThe complete result of a skill recommendation operation.
SearchSkillsOptionsinterfaceOptions for searching skills via marketplace APIs.
RecommendSkillsQueryOptionsinterfaceOptions for the recommendation query combining ranking options with a result…
GitFetchResultinterfaceResult of fetching a Git repository to a local temporary directory.
ValidationIssueinterfaceA single validation issue found during SKILL.md validation.
ValidationResultinterfaceResult of validating a SKILL.md file against the Agent Skills standard.
SpawnOptionsinterfaceOptions for spawning a subagent.
SpawnResultinterfaceResult from a spawn operation.
SpawnAdapterinterfaceProvider-neutral interface for spawning and managing subagents. Concrete imp…
SkillIntegrityStatustypeStatus of a single skill’s integrity check.
SkillIntegrityResultinterfaceResult of checking a single skill’s integrity.
ResolvedImportsinterfaceResult of resolving lines in content.
WellKnownSkillinterfaceA skill entry discovered via the RFC 8615 well-known endpoint.

Other Exports

SymbolKindDescription
forge-ts.config.tsfile
tsup.config.tsfile
vitest.config.tsfile
generate-hook-types.tsfile
provider-research.tsfile
skill-library.tsfile
types.tsfile
types.tsfile
platform-paths.tsfile
standard.tsfile
providers.tsfile
templates.tsfile
injector.tsfile
AGENTS_HOMEvariableGlobal .agents/ home directory (~/.agents/ or $AGENTS_HOME).
LOCK_FILE_PATHvariableCAAMP lock file path (~/.agents/.caamp-lock.json).
CANONICAL_SKILLS_DIRvariableCanonical skills directory (~/.agents/skills/).
AGENTS_MCP_DIRvariableGlobal MCP directory (~/.agents/mcp/).
AGENTS_MCP_SERVERS_PATHvariableGlobal MCP servers.json path (~/.agents/mcp/servers.json).
AGENTS_CONFIG_PATHvariableGlobal agents config.toml path (~/.agents/config.toml).
agents.tsfile
logger.tsfile
detection.tsfile
installer.tsfile
orchestration.tsfile
ErrorCategoriesvariableCommon error categories mapping for convenience.
ErrorCodesvariableCommon error codes for consistency.
lafs.tsfile
lafs.tsfile
common.tsfile
batch.tsfile
instructions.tsfile
providers.tsfile
index.tsfileAdvanced orchestration command group providing LAFS-compliant wrappers for ba…
utils.tsfile
json.tsfile
toml.tsfile
yaml.tsfile
index.tsfileProvides format-agnostic config read, write, and remove operations that dispa…
config.tsfile
lock-utils.tsfile
version.tsfile
doctor.tsfile
check.tsfile
inject.tsfile
update.tsfile
index.tsfileInstruction file management command group for injecting, checking, and updati…
HOOK_CATEGORIESvariableAll hook event categories (8 total).
EVENT_SOURCESvariableEvent source types: domain, provider.
CANONICAL_HOOK_EVENTSvariableAll canonical hook events (31 total: 16 provider, 15 domain). This replaces…
PROVIDER_HOOK_EVENTSvariableProvider-sourced events only (original 16 CAAMP events).
DOMAIN_HOOK_EVENTSvariableDomain-sourced events only (CLEO business events).
EVENT_METADATAvariableMetadata for each canonical event, derived from hook-mappings.json.
generated.tsfile
types.tsfile
normalizer.tsfile
index.tsfileCAAMP Hooks Module Unified hook normalization layer that translates between…
providers.tsfile
AUDIT_RULESvariableComplete set of security audit rules for SKILL.md scanning.
rules.tsfile
scanner.tsfile
audit.tsfile
parser.tsfile
lock.tsfile
check.tsfile
DEFAULT_FETCH_TIMEOUT_MSvariableDefault timeout in milliseconds for outbound HTTP requests.
fetch.tsfile
types.tsfile
skillsmp.tsfile
skillssh.tsfile
client.tsfile
RECOMMENDATION_ERROR_CODESvariableError codes used in skill recommendation validation.
rankSkillsvariableAlias for recommendSkills providing a shorter function name.
recommendation.tsfile
recommendation-api.tsfile
find.tsfile
init.tsfile
library-loader.tsfile
catalog.tsfile
discovery.tsfile
github.tsfile
gitlab.tsfile
install.tsfile
list.tsfile
remove.tsfile
update.tsfile
validator.tsfile
validate.tsfile
index.tsfileSkills management command group for installing, removing, listing, finding, c…
cli.tsfile
spawn-adapter.tsfile
integrity.tsfile
index.tsfileProvides the public API surface for the CAAMP library, re-exporting types, re…
cant-resolver.tsfile
wellknown.tsfile
cli.test.tsfile
config-providers.test.tsfile
coverage-config-providers-doctor.test.tsfile
coverage-instructions.test.tsfile
instructions-command-wrappers.test.tsfile
skill-install.test.tsfile
skills-commands-coverage.test.tsfile
skills-commands.test.tsfile
skills-find-recommendation.test.tsfile
skills-format-errors.test.tsfile
skills-protocol-format-errors.test.tsfile
skills-update-readline.test.tsfile
advanced-common.test.tsfile
advanced-lafs.test.tsfile
advanced-orchestration.test.tsfile
cant-resolver.test.tsfile
catalog.test.tsfile
core-coverage-gaps.test.tsfile
coverage-clone-cleanup.test.tsfile
coverage-deep-branches.test.tsfile
coverage-final-push.test.tsfile
coverage-lock-installer-mocked.test.tsfile
coverage-network-mocked.test.tsfile
coverage-scanner-mocked.test.tsfile
detection.test.tsfile
doctor.test.tsfile
formats.test.tsfile
hooks-normalizer.test.tsfile
injection-templates.test.tsfile
injector-idempotent.test.tsfile
installer.test.tsfile
instructions.test.tsfile
lock-utils.test.tsfile
lock.test.tsfile
logger.test.tsfile
marketplace.test.tsfile
network-fetch.test.tsfile
paths-standard.test.tsfile
recommendation-api.test.tsfile
recommendation.test.tsfile
registry.test.tsfile
skill-integrity.test.tsfile
skill-library.test.tsfile
skills-audit.test.tsfile
skills-discovery.test.tsfile
skills-installer.test.tsfile
skills-lock.test.tsfile
source-fetchers.test.tsfile
source-parser.test.tsfile
spawn-adapter.test.tsfile
validator.test.tsfile
version.test.tsfile