Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommy-mitchell/bin-path-cli
Execute the current package's binary.
https://github.com/tommy-mitchell/bin-path-cli
bin binary cli-app command-line-tool executable node-js npm-package package package-json shell terminal testing unit-testing
Last synced: about 2 months ago
JSON representation
Execute the current package's binary.
- Host: GitHub
- URL: https://github.com/tommy-mitchell/bin-path-cli
- Owner: tommy-mitchell
- License: mit
- Created: 2023-03-21T02:49:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T19:58:54.000Z (over 1 year ago)
- Last Synced: 2024-11-29T14:48:51.424Z (2 months ago)
- Topics: bin, binary, cli-app, command-line-tool, executable, node-js, npm-package, package, package-json, shell, terminal, testing, unit-testing
- Language: TypeScript
- Homepage: https://npm.im/bin-path-cli
- Size: 159 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# bin-path-cli
Execute the current package's binary.
Like using `npm link`, but doesn't add your binary to the global path.
*Demo with [`listr-cli`](https://github.com/tommy-mitchell/listr-cli).*
## Install
```sh
npm install --global bin-path-cli
```
Other Package Managers
```sh
yarn global add bin-path-cli
```
## Usage
```sh
npx bin-path [source-map] [binary-name] [arguments or flags…]
```
### Curent Working Directory
Inside of a directory with a `package.json` that specifies a binary either via `bin` or `directories.bin`, run via:
```sh
npx bin-path
```
If no binary is found, the `bin-path` command fails.
### Arguments
Flags and arguments are passed as-is to your binary:
```sh
$ npx bin-path --some-flag arg1 arg2
```
Example
```js
// cli.js
#!/usr/bin/env node
import process from "node:process";
const args = process.argv.slice(2);
console.log(`Arguments: [${args.join(", ")}]`);
```
```sh
$ npx bin-path arg1 arg2
#=> "Arguments: [arg1, arg2]"
```
### Named binaries
If you have multiple exported binaries, they can be accessed by name if passed as the first argument to `bin-path`:
```sh
$ npx bin-path binary-name
```
Example
```jsonc
// package.json
"bin": {
"foo": "./foo.js",
"bar": "./bar.js"
}
```
```sh
# `foo` binary
$ npx bin-path foo --foo-flag
# `bar` binary
$ npx bin-path bar --bar-flag
```
Omitting a name searches for a binary with the same name as the project (i.e. `name` in `package.json`). This is the "default" binary.
Example
```jsonc
// package.json
"name": "foo",
"bin": {
"foo": "./foo.js",
"bar": "./bar.js"
}
```
```sh
# `foo` binary
$ npx bin-path --foo-flag
```
### Source Mapping
If you're writing your binary in a language that compiles to JavaScript (e.g. TypeScript) and would like to test your source binary, you can map the built file to the source file by using the following format as the first argument to `bin-path`:
```sh
$ npx bin-path dist.js:::src.ts
```
Example
```
\__ dist/
\__ cli.js
\__ src/
\__ cli.ts
\__ package.json
```
#### Aliasing
The syntax for mapping to a source binary can be verbose. Adding the following as an alias to your `.zshrc` (or equivalent) could help:
```sh
alias bin-path-map="bin-path dist.js:::src.ts"
```
> [!NOTE]
> The feature is under-tested and the syntax is subject to change. If you have any problems or suggestings, please [file an issue](https://github.com/tommy-mitchell/bin-path-cli/issues/new).
## Related
- [get-bin-path](https://github.com/ehmicky/get-bin-path) - Get the current package's binary path.