ek9_install_package
Answers with installedTo (under ~/.ek9/lib) and bundlePath after packaging one package and installing its SOURCE bundle into the LOCAL library cache - not a remote registry push.
When to use it
'Install this package into the local library for other workspaces on this machine' is one call with file:'package.ek9'. It packages first, then copies the bundle into ~/.ek9/lib.
When not to use it
- Only building the bundle, no install - use
ek9_package. - Publishing to the REMOTE registry rather than the local cache - use
ek9_deploy_package. - Fetching this package's DECLARED dependencies (the consumer direction) - use
ek9_resolve_dependencies.
Details
Wraps ek9 -I: the same packaging pipeline as ek9_package (compile + tests + 80% coverage gate), then the versioned zip and its .sha256 are copied into ~/.ek9/lib/ - never a remote registry. installedTo is reported only when the copy exists on disk after the run. Consumers' compilers build the installed SOURCE on first use.
Arguments
| Argument | Type | Required | What it is |
|---|---|---|---|
file | string | yes | The .ek9 file holding the 'defines package' block, workspace-relative (typically 'package.ek9'); an absolute path inside the workspace is accepted. |
verbosity | string: full | summary | none | Response size. The default answers with status, summary, bundlePath and installedTo; 'full' adds the CLI's stdout, argv, exitCode, elapsedMs and timedOut. |
Recorded calls
Real calls, recorded against small projects and checked on every build - a changed answer fails it.
Installed shape
Request
{
"file" : "<workspace-root>/package.ek9"
}
Response
{
"bundlePath" : ".ek9/com.example.pkg-1.0.0-0.zip",
"checksumPath" : ".ek9/com.example.pkg-1.0.0-0.zip.sha256",
"file" : "package.ek9",
"installedTo" : "~/.ek9/lib/com.example.pkg-1.0.0-0.zip",
"meta" : {
"serverMs" : "<timing>"
},
"status" : "ok",
"summary" : "installed: com.example.pkg-1.0.0-0.zip"
}
See also
- Show me in the IDE: Build: package, install, sign, deploy
- Part of the release workflow: Bump version + run tests with coverage + build artefact + install locally + verify.