install

API Docs

---

Function: install()

install(config?): Promise<InstallResult>

Defined in: src/install/index.ts:148

Main installation function.

This function checks prerequisites and provides setup guidance. Actual package installation is handled by the shell scripts (install.sh, install-linux.sh, install-macos.sh, install.ps1).

Parameters

config?

Partial<InstallConfig>

Partial configuration options

Returns

Promise<InstallResult>

Installation result with success status and duration. Note: packagesInstalled will be empty as this module only validates prerequisites, not installs packages.