# @openjdl/cli

> > WIP

Latest version **0.1.2** (published 2021-08-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @openjdl/cli
pnpm add @openjdl/cli
yarn add @openjdl/cli
bun add @openjdl/cli
```

Provides the command `openjdl`.

## 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.1.2 |
| Published | 2021-08-23 |
| First published | 2021-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 26.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | kidalsama |
| Maintainers | kidalsama |

## Links

- npm: https://www.npmjs.com/package/@openjdl/cli
- Repository: https://github.com/openjdl/openjdl-cli
- Homepage: https://github.com/openjdl/openjdl-cli#readme
- Issues: https://github.com/openjdl/openjdl-cli/issues
- npm.io page: https://npm.io/package/@openjdl/cli

## Dependencies (18)

- [ora](https://npm.io/package/ora.md) ^5.4.1
- [async](https://npm.io/package/async.md) ^3.2.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [tildify](https://npm.io/package/tildify.md) ^2.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.1.2
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4
- [user-home](https://npm.io/package/user-home.md) ^3.0.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.7
- [metalsmith](https://npm.io/package/metalsmith.md) ^2.3.0
- [multimatch](https://npm.io/package/multimatch.md) ^5.0.0
- [consolidate](https://npm.io/package/consolidate.md) ^0.16.0
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.3
- [read-metadata](https://npm.io/package/read-metadata.md) ^1.0.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^5.1.0
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^3.0.2
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) ^3.0.0

## Recent versions

- 0.1.2 (latest) — 2021-08-23
- 0.1.1 — 2021-08-23
- 0.1.0 — 2021-08-23

## README

# OpenJDL CLI
> WIP



## Installation

First, make sure you have Node >= 14 and NPM >= 7.

```bash
# install OpenJDL CLI:
$ npm install -g @openjdl/cli

# or use yarn:
$ yarn global add @openjdl/cli
```



## Generate

> Generate files from template

**Usage**

```shell
$ openjdl generate [--kit <kit-name>] [--branch <version-name>]
# or
$ openjdl gen [--kit <kit-name>] [--branch <version-name>]
```

**Options**

```shell
--kit, -k      Use specific kit
--branch, -b   Use specific branch of the kit, default main
--clone, -c    Use git clone
--offline, -o  Use a cached kit
--token, -t    Gitlab private token
--help, -h     Displays help message
```

**Example**

```bash
# generate with example
$ openjdl generate <folder_name>

# use your github kit
$ openjdl generate <folder_name> --kit my_group/my_project

# use your gitlab kit
$ openjdl generate <folder_name> --kit gitlab:my_gitlab.com:my_group/my_project

# use your gitlab kit with private token
$ openjdl generate <folder_name> --kit gitlab:my_gitlab.com:my_group/my_project --token my_token
```

## License

Copyright (c) 2021-present Teng Da

[MIT License](http://en.wikipedia.org/wiki/MIT_License)

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