knowhub
Version:
Synchronize AI coding–agent knowledge files (rules, templates, guidelines) across your project.
48 lines • 1.43 kB
TypeScript
/**
* Configuration object for knowhub
*/
export interface Config {
/** Plugin file paths for dynamic loading (optional) */
plugins?: string[];
/** Resources to synchronize */
resources: Resource[];
}
/**
* Definition of a single resource to be synchronized
*/
export interface Resource {
/** Plugin name */
plugin: string;
/** Plugin-specific configuration */
pluginConfig: unknown;
/** Whether to overwrite existing files at output locations */
overwrite?: boolean;
/** Output destinations (relative to project root) */
outputs: string | string[];
}
/**
* A resource after it has been fetched/resolved
*/
export interface FetchedResource {
/** Original resource definition */
definition: ValidatedResource;
/** Absolute local path (for local resources) */
localPath?: string;
/** Whether the local path is a directory */
isDirectory?: boolean;
/** Content from remote URL (for remote resources) */
content?: string;
/** Plugin-specific metadata */
pluginMetadata?: Record<string, unknown>;
}
/**
* Validated resource definition with normalized fields
*/
export interface ValidatedResource {
plugin: string;
pluginConfig: unknown;
overwrite: boolean;
outputs: string[];
}
export declare function loadConfig(configPath?: string, projectRoot?: string): Promise<ValidatedResource[]>;
//# sourceMappingURL=config.d.ts.map