Member Junction
    Preparing search index...

    Class InstallPlan

    An install plan that describes the full sequence of phases the engine will execute, including which phases to skip.

    Created by InstallerEngine.CreatePlan and passed to InstallerEngine.Run for execution. Can also be inspected via Summarize for dry-run display.

    const plan = new InstallPlan('v5.1.0', '/path/to/install', config, new Set(['smoke_test']));
    console.log(plan.Summarize());
    // Install Plan
    // ────────────
    //   Tag:       v5.1.0
    //   Directory: /path/to/install
    //   ...
    //   Phases:
    //          preflight      Check prerequisites (Node, npm, disk, ports, DB)
    //     (skip) smoke_test     Start services and run smoke tests
    Index

    Constructors

    constructor

    Properties

    Config CreatedAt Dir NoClaudePack Phases Tag

    Methods

    Summarize

    Constructors

    Properties

    Config: PartialInstallConfig

    Merged configuration (defaults + user-supplied + prompted values).

    CreatedAt: Date

    Timestamp when this plan was created.

    Dir: string

    Absolute path to the target install directory.

    NoClaudePack: boolean

    Whether to skip the Claude Code pack during scaffolding. Defaults to false — the pack ships alongside the distribution. --no-claude-pack flips this on.

    Phases: PhaseInfo[]

    Ordered list of phases with skip flags and descriptions.

    Tag: string

    Git tag of the version to install (e.g., "v5.1.0" or "latest").

    Methods

    • Generate a human-readable summary of the install plan.

      Used for dry-run display and CLI output. Shows the tag, directory, creation timestamp, and each phase with its skip status.

      Returns string

      Multi-line string suitable for terminal display.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods