npm package: @shongcheng/bin-exe-to-npm
Description: CLI to publish executables as a NPM package
Author: shongcheng @shongcheng
Latest version: 0.1.0

bin-exe-to-npm
==============

CLI to publish executables as a NPM package

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @shongcheng/bin-exe-to-npm
$ bin-exe-to-npm COMMAND
running command...
$ bin-exe-to-npm (--version)
@shongcheng/bin-exe-to-npm/0.1.0 win32-x64 node-v18.18.1
$ bin-exe-to-npm --help [COMMAND]
USAGE
  $ bin-exe-to-npm COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`bin-exe-to-npm help [COMMANDS]`](#bin-exe-to-npm-help-commands)
* [`bin-exe-to-npm plugins`](#bin-exe-to-npm-plugins)
* [`bin-exe-to-npm plugins:install PLUGIN...`](#bin-exe-to-npm-pluginsinstall-plugin)
* [`bin-exe-to-npm plugins:inspect PLUGIN...`](#bin-exe-to-npm-pluginsinspect-plugin)
* [`bin-exe-to-npm plugins:install PLUGIN...`](#bin-exe-to-npm-pluginsinstall-plugin-1)
* [`bin-exe-to-npm plugins:link PLUGIN`](#bin-exe-to-npm-pluginslink-plugin)
* [`bin-exe-to-npm plugins:uninstall PLUGIN...`](#bin-exe-to-npm-pluginsuninstall-plugin)
* [`bin-exe-to-npm plugins:uninstall PLUGIN...`](#bin-exe-to-npm-pluginsuninstall-plugin-1)
* [`bin-exe-to-npm plugins:uninstall PLUGIN...`](#bin-exe-to-npm-pluginsuninstall-plugin-2)
* [`bin-exe-to-npm plugins update`](#bin-exe-to-npm-plugins-update)
* [`bin-exe-to-npm publish`](#bin-exe-to-npm-publish)

## `bin-exe-to-npm help [COMMANDS]`

Display help for bin-exe-to-npm.

```
USAGE
  $ bin-exe-to-npm help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for bin-exe-to-npm.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.19/src/commands/help.ts)_

## `bin-exe-to-npm plugins`

List installed plugins.

```
USAGE
  $ bin-exe-to-npm plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ bin-exe-to-npm plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/index.ts)_

## `bin-exe-to-npm plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ bin-exe-to-npm plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ bin-exe-to-npm plugins add

EXAMPLES
  $ bin-exe-to-npm plugins:install myplugin 

  $ bin-exe-to-npm plugins:install https://github.com/someuser/someplugin

  $ bin-exe-to-npm plugins:install someuser/someplugin
```

## `bin-exe-to-npm plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ bin-exe-to-npm plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ bin-exe-to-npm plugins:inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/inspect.ts)_

## `bin-exe-to-npm plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ bin-exe-to-npm plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ bin-exe-to-npm plugins add

EXAMPLES
  $ bin-exe-to-npm plugins:install myplugin 

  $ bin-exe-to-npm plugins:install https://github.com/someuser/someplugin

  $ bin-exe-to-npm plugins:install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/install.ts)_

## `bin-exe-to-npm plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ bin-exe-to-npm plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ bin-exe-to-npm plugins:link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/link.ts)_

## `bin-exe-to-npm plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ bin-exe-to-npm plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ bin-exe-to-npm plugins unlink
  $ bin-exe-to-npm plugins remove
```

## `bin-exe-to-npm plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ bin-exe-to-npm plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ bin-exe-to-npm plugins unlink
  $ bin-exe-to-npm plugins remove
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/uninstall.ts)_

## `bin-exe-to-npm plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ bin-exe-to-npm plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ bin-exe-to-npm plugins unlink
  $ bin-exe-to-npm plugins remove
```

## `bin-exe-to-npm plugins update`

Update installed plugins.

```
USAGE
  $ bin-exe-to-npm plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/update.ts)_

## `bin-exe-to-npm publish`

publish specified Windows and Linux executables as NPM package directly executable with NPX

```
USAGE
  $ bin-exe-to-npm publish -n <value> -v <value> --windows-exe-from <value> --windows-exe-to <value>
    [--linux-bin-from <value>] [--linux-bin-to <value>] [--registry <value>] [--dry-run]

FLAGS
  -n, --name=<value>          (required) name of the package to be published
  -v, --version=<value>       (required) version of the package to be published
  --dry-run                   performs a dry-run by printing the package.json file to be used for publishing
  --linux-bin-from=<value>    path to the Linux bin file to copy from
  --linux-bin-to=<value>      destination name of the Linux bin file
  --registry=<value>          [default: http://localhost:4873/] URL to package registry
  --windows-exe-from=<value>  (required) path to the Windows exe file to copy from
  --windows-exe-to=<value>    (required) destination name of the Windows exe file

DESCRIPTION
  publish specified Windows and Linux executables as NPM package directly executable with NPX

EXAMPLES
  $ bin-exe-to-npm publish --name my-package --version 1.1.1 --linux-bin-from /home/user1/bin/tool --linux-bin-to tool --windows-exe-from c:/appl/bin/tool.exe --windows-exe-to tool.exe

  $ bin-exe-to-npm publish --dry-run --name my-package --version 1.1.1 --linux-bin-from /home/user1/bin/tool --linux-bin-to tool --windows-exe-from c:/appl/bin/tool.exe --windows-exe-to tool.exe
```

_See code: [dist/commands/publish.ts](https://gitlab.com/shongcheng/bin-exe-to-npm/blob/v0.1.0/dist/commands/publish.ts)_
<!-- commandsstop -->