# lkpm-cli

> Global package to assist in development of LabKey modules.

Latest version **0.2.0** (published 2017-05-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install lkpm-cli
pnpm add lkpm-cli
yarn add lkpm-cli
bun add lkpm-cli
```

Provides the command `lkpm`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2017-05-25 |
| First published | 2017-04-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jon Richardson |
| Maintainers | jonathonrichardson |

## Links

- npm: https://www.npmjs.com/package/lkpm-cli
- Repository: https://github.com/WNPRC-EHR-Services/lkpm-cli
- Homepage: https://github.com/WNPRC-EHR-Services/lkpm-cli#readme
- Issues: https://github.com/WNPRC-EHR-Services/lkpm-cli/issues
- npm.io page: https://npm.io/package/lkpm-cli

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [yargs](https://npm.io/package/yargs.md) ^7.1.0
- [dotenv](https://npm.io/package/dotenv.md) ^4.0.0
- [mkpath](https://npm.io/package/mkpath.md) ^1.0.0
- [fs-sync](https://npm.io/package/fs-sync.md) ^1.0.4
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.8.3
- [empty-dir](https://npm.io/package/empty-dir.md) ^0.2.1
- [in-publish](https://npm.io/package/in-publish.md) ^2.0.0

## Recent versions

- 0.2.0 (latest) — 2017-05-25
- 0.1.1 — 2017-04-27
- 0.1.0 — 2017-04-27

## README

# lkpm-cli
Global package to assist in development of LabKey modules.

## Installation
Install this utility with npm (if you're using OSX, you'll need to use `sudo`):

```
npm install -g lkpm-cli
```

To see the available options, execute the help command:

```
lkpm --help
```

## Generate Docker Compose Configuration
To generate a docker compose configuration in your current directory (it must be empty), execute the following command:

```
lkpm gddc .
```

You can pass the `--help` option to `lkpm gddc` to see the options.  They are as follows:

Option     |Shortcut|Description
-----------|--------|-----------
`--envfile`|`-e`    |You can use this option to pass a path to an .env file with default values to override the generated `.env` file.  For instance, you can create `~/docker.defaults.env` containing entries for the modules source directory, usernames, and passwords, so that you don't have to manually add those values to every single generated `.env file`.
`--mode`   |`-m`    |There are three modes: **prd**, **dev**, and **tst**.  See below for more information regarding what each mode means.

There are three different modes for the LabKey docker composition to run in, that have a few differences:

- In **prd** and **tst**, the composition listens on ports 80 and 443 for HTTP and HTTPS traffic, respectively.  In **dev** mode, the server only listens for HTTPS connections on port 8888. 
- In **dev** mode, the composition enables the Java debugger for Tomcat listening on 5005.
- In **dev** mode, LabKey runs with the `-ea`, `-Ddevmode=true`, and `-Ddeploy.dir=/usr/local/labkey` Java options.
- In **dev** mode, LabKey mounts **LK_MODSRC_DIR** from the `.env` file into the LabKey docker container at `/LabKey/sources` to allow live development of modules.

---
_Source: https://npm.io/package/lkpm-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._