function init
init(options?: InitOptions): Promise<InitResult>

Initialize Aichaku globally or in a project

This command sets up Aichaku for use with Claude. Global installation is required before project-specific initialization can be done.

Global initialization (--global):

  • Installs all methodologies to ~/.claude/
  • Downloads standards library
  • Creates user customization directory
  • Required before any project initialization

Project initialization (default):

  • Creates minimal .claude/ structure in project
  • References global methodologies
  • Creates project-specific customization area
  • Requires global installation first

Examples

Example 1

// First time setup - install globally
await init({ global: true });

// Initialize in a project
await init({ projectPath: "/path/to/project" });

// Preview what would be done
await init({ dryRun: true });

// Force reinstall
await init({ global: true, force: true });

Parameters

optional
options: InitOptions
  • Initialization options

Return Type

Promise<InitResult>

Result indicating success and what was done

Usage

import { init } from ".";