Skip to content
← Public packages

@hypercubed/aksk

AKSK setup planner for coding agents: tailored install plans, live peer-tool versions, managed templates, paste-in validators.

src/index.ts

27 lines · 1.1 KB · TypeScript
/**
 * Package overview for @hypercubed/aksk.
 * Use to discover what this package offers before calling a specific export.
 *
 * @returns Package name plus the export inventory with when-to-use guidance
 *
 * @example
 * import main from 'kody:@hypercubed/aksk'
 *
 * const info = await main()
 */
export default async function main(): Promise<{
	package: string
	exports: { name: string; useWhen: string }[]
	note: string
}> {
	return {
		package: '@hypercubed/aksk',
		exports: [
			{ name: 'plan-setup', useWhen: 'User asks how to install AKSK — returns only the lanes they need.' },
			{ name: 'resolve-versions', useWhen: 'Setup instructions need peer-tool versions — bundled pins or live npm lookup.' },
			{ name: 'render-template', useWhen: 'Local agent needs byte-exact marker blocks or ignore rules to write.' },
			{ name: 'validate-paste', useWhen: 'User pastes AGENTS.md / SKILL.md / .gitignore and wants a wiring check.' },
		],
		note: 'Cloud-worker side only: this package plans, resolves, renders, and validates. It cannot check local PATH, run npm, or write local files — the calling agent runs the returned commands.',
	}
}