6.0.0 • Published 1 year ago
@zkochan/cmd-shim v6.0.0
@zkochan/cmd-shim
Used in pnpm for command line application support
The cmd-shim used in pnpm to create executable scripts.
Installation
npm install --save @zkochan/cmd-shim
API
cmdShim(src, to, opts?): Promise<void>
Create a cmd shim at to
for the command line program at from
.
e.g.
const cmdShim = require('@zkochan/cmd-shim')
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name')
.catch(err => console.error(err))
cmdShim.ifExists(src, to, opts?): Promise<void>
The same as above, but will just continue if the file does not exist.
Arguments:
opts.preserveSymlinks
- Boolean - if true,--preserve-symlinks
is added to the options passed to NodeJS.opts.nodePath
- String - sets the NODE_PATH env variable.opts.prependToPath
- String - prepends the passed path to PATH before executing the Node.js program.opts.nodeExecPath
- String - sets the path to the Node.js executable.opts.createCmdFile
- Boolean - istrue
on Windows by default. If true, creates a cmd file.opts.createPwshFile
- Boolean - istrue
by default. If true, creates a powershell file.opts.progArgs
- String - optional arguments that will be prepend to any CLI arguments
const cmdShim = require('@zkochan/cmd-shim')
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', { preserveSymlinks: true })
.catch(err => console.error(err))
License
6.0.0
1 year ago
5.4.1
1 year ago
5.4.0
1 year ago
5.3.1
2 years ago
5.2.2
2 years ago
5.3.0
2 years ago
5.2.1
3 years ago
5.2.0
3 years ago
5.1.3
3 years ago
5.1.2
3 years ago
5.1.1
3 years ago
5.1.0
3 years ago
5.0.0
4 years ago
4.3.0
4 years ago
4.2.1
4 years ago
4.2.0
5 years ago
4.1.0
5 years ago
4.0.0
5 years ago
3.1.0
6 years ago
3.0.1
6 years ago
3.0.0
6 years ago
2.2.4
7 years ago
2.2.3
7 years ago
2.2.2
7 years ago
2.2.1
7 years ago
2.2.0
7 years ago
2.1.0
7 years ago
2.0.1
7 years ago
2.0.0
7 years ago
1.0.0
8 years ago