Installations

npm install @zkochan/cmd-shim

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Min. Node Version

>=18.12

Node Version

20.19.0

NPM Version

10.8.2 Score

98.6

Supply Chain

84.1

Quality

76.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

35

Closed

4

Merged

30

Issues

Open

4

Total

12

Closed

8

Releases

Unable to fetch releases

Languages

2

TypeScript

JavaScript

TypeScript (72.44%)

JavaScript (27.56%)

Developer

pnpm

Download Statistics

Total Downloads

168,867,038

Last Day

37,873

Last Week

624,653

Last Month

2,747,636

Last Year

23,421,306

GitHub Statistics

NOASSERTION License

14 Stars

174 Commits

12 Forks

4 Watchers

3 Branches

38 Contributors

Updated on Apr 29, 2025

Bundle Size

17.24 kB

Minified

5.80 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 38 Contributors

Package Meta Information

Latest Version

7.0.0

Package Id

@zkochan/cmd-shim@7.0.0

Unpacked Size

37.45 kB

Size

10.38 kB

File Count

7

NPM Version

10.8.2

Node Version

20.19.0

Published on

Apr 21, 2025

Total Downloads

Cumulative downloads

Total Downloads

168,867,038

Last Day

-29.1%

37,873

Compared to previous day

Last Week

-12.5%

624,653

Compared to previous week

Last Month

16.9%

2,747,636

Compared to previous month

Last Year

-4%

23,421,306

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

cmd-extension graceful-fs is-windows

Dev Dependencies

11

@types/is-windows @types/jest @types/node jest memfs mock-fs mos mos-plugin-readme standard tempy typescript

@zkochan/cmd-shim

Used in pnpm for command line application support

The cmd-shim used in pnpm to create executable scripts.

Installation

1npm 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.

1const cmdShim = require('@zkochan/cmd-shim')
2cmdShim(__dirname + '/cli.js', '/usr/bin/command-name')
3  .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 - is true on Windows by default. If true, creates a cmd file.
opts.createPwshFile - Boolean - is true by default. If true, creates a powershell file.
opts.progArgs - String - optional arguments that will be prepend to any CLI arguments

1const cmdShim = require('@zkochan/cmd-shim')
2cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', { preserveSymlinks: true })
3  .catch(err => console.error(err))

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

6

Maintained

Determines if the project is "actively maintained".

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

2.7

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More