# qckwinsvc2

> CLI tool that installs/uninstalls your NodeJS app as a windows service

Latest version **1.0.2** (published 2021-04-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install qckwinsvc2
pnpm add qckwinsvc2
yarn add qckwinsvc2
bun add qckwinsvc2
```

Provides the command `qckwinsvc2`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-04-27 |
| First published | 2021-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 28.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Suyeon |
| Maintainers | suyeonorg |
| Keywords | qckwinsvc2, qckwinsvc, windows, services, node-windows |

## Links

- npm: https://www.npmjs.com/package/qckwinsvc2
- Repository: https://github.com/suyeonORG/qckwinsvc2
- Homepage: https://github.com/suyeonORG/qckwinsvc2#readme
- Issues: https://github.com/suyeonORG/qckwinsvc2/issues
- npm.io page: https://npm.io/package/qckwinsvc2

## Dependencies (1)

- [node-windows](https://npm.io/package/node-windows.md) ^1.0.0-beta.5

## Recent versions

- 1.0.2 (latest) — 2021-04-27
- 1.0.1 — 2021-04-26
- 1.0.0 — 2021-04-24

## README

# <img src="suyeon.png" alt="drawing" width="26"/> Quick Windows Service 2

[![dependencies](https://david-dm.org/suyeonORG/qckwinsvc2.png)](https://david-dm.org/suyeonORG/qckwinsvc2)
[![devDependencies](https://david-dm.org/suyeonORG/qckwinsvc2/dev-status.png)](https://david-dm.org/suyeonORG/qckwinsvc2#info=devDependencies)
[![npm module](https://badge.fury.io/js/qckwinsvc2.png)](http://badge.fury.io/js/qckwinsvc2)

CLI tool that installs/uninstalls your NodeJS app as a windows service. qckwinsvc2 is a Wrapper around [node-windows](https://github.com/coreybutler/node-windows).

This is a new version based on [qckwinsvc](https://github.com/tallesl/qckwinsvc) which is not maintained anymore. This new CLI supports additional features such as argument passing.

Special thanks to [tallesl](https://github.com/tallesl)

Made with ♡ by Suyeon® feel free to download, modify or publish this code as you want.

Visit [suyeon.org](https://suyeon.org) for more information.

## Setup

```
npm i qckwinsvc2 -g
```

# Table of Contents

1. [Installing your service](#installing-your-service)
2. [Uninstalling your service](#uninstalling-your-service)
3. [List installed services](#list-installed-services)
4. [Start/Stop services](#start-and-stop-your-service)
5. [Disclaimer](#disclaimer)

## Installing your service

### Interactively

```
> qckwinsvc2 install
[INPUT] Please provide a name for your service: Hello
[INPUT] Please provide a description for your service: Greets the world
[INPUT] Please provide your script's path:  C:\index.js
[OPTIONAL] Please provide your script's arguments:
[INFO] Service Hello installed.
[INFO] Service Hello started.
```

### Non-interactively

```
> qckwinsvc2 install name="Hello" description="World" path="C:\index.js" args="-a -c" now
[INFO] Service Hello installed.
[INFO] Service Hello started.
```

## Uninstalling your service

### Interactively

```
> qckwinsvc2 uninstall
[INPUT] Please provide a name for your service: Hello
[INFO] Service Hello stopped.
[INFO] Service Hello uninstalled.
```

### Non-interactively

```
> qckwinsvc2 uninstall name="Hello"
[INFO] Service Hello stopped.
[INFO] Service Hello uninstalled.
```

## Start and stop your service

### Interactively

```
> qckwinsvc2 start
[INPUT] Please provide a name for your service: Hello
[INFO] Service Hello started.
```

### Non-interactively

```
> qckwinsvc2 start name="Hello"
[INFO] Service Hello started.
```

## List installed services

```
> qckwinsvc2 list
[INFO] Here's a list of all the services installed through qckwinsvc2:
    [1]    Hello
    [2]    World
```

## Disclaimer

<img src="suyeon.png" alt="drawing" width="64"/>

Made with ♡ by Suyeon® feel free to download, modify or publish this code as you want.

Visit [suyeon.org](https://suyeon.org) for more information.

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