dev install
Point the application's installed executable at a checkout
- Command version
0.0.0- Command configuration
cli:cli.install@0.0.0
Arguments
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--path | string | No | "." | Checkout to install the application from (default: current directory): a tree holding its repository, the distribution itself, or the package directory inside it. Whatever is checked out there is what the executable will read |
--tool-root | string | No | Directory the tool environment and its entry point are placed under, for an install that must not replace the one on PATH; without it the machine's own tool root is used | |
--force, --no-force | boolean | No | false | Rebuild the tool environment even when the install already reads this checkout and boots -- what a dependency change needs, and what a source change does not, since an editable install reads the checkout itself |
It also takes the global arguments.
Output
It answers with a install.installSummary.
Types
install.installSummary
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
projectDir | string | No | "" | The distribution the executable was pointed at |
toolRoot | string | No | "" | The tools directory the install was made under, empty for the machine's own |
reinstalled | boolean | No | false | Whether the tool environment was rebuilt |
alreadyCurrent | boolean | No | false | Whether the install already read this distribution and booted, so nothing was rebuilt |
retriedWithoutCache | boolean | No | false | Whether the first install would not start and was made again with the installer's cache bypassed |
blocked | string | No | "" | Why the install was not re-pointed although it needed to be |
blockedByAnotherProcess | boolean | No | false | Whether the refusal is another process holding the environment, rather than this process running from it |
installedAt | string | No | "" | The directory the install reads, as it stood when this finished |
executable | string | No | "" | The installed executable |
executableOk | boolean | No | false | Whether the installed executable starts |