https://github.com/geopjr/pog
A faster npm run & npx
https://github.com/geopjr/pog
crystal npm npx pnpm yarn
Last synced: 10 months ago
JSON representation
A faster npm run & npx
- Host: GitHub
- URL: https://github.com/geopjr/pog
- Owner: GeopJr
- License: bsd-2-clause
- Created: 2022-03-30T19:30:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-27T19:30:22.000Z (almost 4 years ago)
- Last Synced: 2025-06-03T13:18:43.999Z (10 months ago)
- Topics: crystal, npm, npx, pnpm, yarn
- Language: Crystal
- Homepage:
- Size: 35.2 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
🍋 pog 🍋
A faster npm run & npx
#
## What is pog?
It's an extremely fast & dependency-less replacement for `npm run` and `npx`.
Pog is inspired by [@egoist](https://github.com/egoist/)'s [dum](https://github.com/egoist/dum/), but written in Crystal instead of Rust.
> It was really fun trying to optimize it as much as possible!
They are mostly on par in terms of speed and functionality. Pog however is missing the "interactive" mode as I'd rather keep it dependency-less.
#
## Installation
### Pre-built
You can download one of the pre-built binaries from the [releases page](https://github.com/GeopJr/pog/releases/latest) for Linux & MacOS.
For Linux, there's a static build available (and is recommended).
They are built & published by our lovely [actions](https://github.com/GeopJr/pog/actions/workflows/release.yml).
### Building
#### Dependencies
- `crystal` - `1.3.2`
#### Makefile
- `$ make` (or `$ make static` on Alpine Linux for a static build)
- `# make install`
##### Enable Deep-Search
If you build with the `POG_ENABLE_DEEPSEARCH=true` env var, you'll enable deep-search.
Instead of looking for binaries in `node_modules/.bin` it will look through all folders/dependencies.
#
## Benchmarks
`$ hyperfine "./pog-static foo" "./pog foo" "./dum foo" "npm run foo" --warmup 10`
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
| :--------------: | :----------: | :------: | :------: | :---------: |
| `pog-static foo` | 51.4 ± 8.4 | 38.4 | 69.9 | 1.00 |
| `dum foo` | 51.9 ± 9.2 | 40.9 | 72.1 | 1.01 ± 0.24 |
| `pog foo` | 52.5 ± 8.8 | 40.0 | 77.3 | 1.02 ± 0.24 |
| `npm run foo` | 376.2 ± 10.5 | 352.9 | 385.3 | 7.31 ± 1.21 |
Full Log
```
Benchmark 1: ./pog-static foo
Time (mean ± σ): 51.4 ms ± 8.4 ms [User: 40.9 ms, System: 11.3 ms]
Range (min … max): 38.4 ms … 69.9 ms 66 runs
Benchmark 2: ./pog foo
Time (mean ± σ): 52.5 ms ± 8.8 ms [User: 41.5 ms, System: 12.6 ms]
Range (min … max): 40.0 ms … 77.3 ms 53 runs
Benchmark 3: ./dum foo
Time (mean ± σ): 51.9 ms ± 9.2 ms [User: 41.2 ms, System: 11.1 ms]
Range (min … max): 40.9 ms … 72.1 ms 47 runs
Benchmark 4: npm run foo
Time (mean ± σ): 376.2 ms ± 10.5 ms [User: 423.6 ms, System: 51.5 ms]
Range (min … max): 352.9 ms … 385.3 ms 10 runs
Summary
'./pog-static foo' ran
1.01 ± 0.24 times faster than './dum foo'
1.02 ± 0.24 times faster than './pog foo'
7.31 ± 1.21 times faster than 'npm run foo'
```
| Whisker Plot | Histogram |
| :----------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------: |
|  |  |
> Please don't take these benchmarks too seriously.
#
```
$ pog -h
pog v1.0.0
USAGE:
pog [OPTIONS] COMMAND [ARGS]
COMMANDS:
Run a script
run List available scripts
run Same as
add Same as (p)npm i or yarn add
i, install Same as (p)npm/yarn install
remove, uninstall Same as (p)npm/yarn remove
FLAGS:
-c INPUT, --cd=INPUT Change working directory
-h, --help Show this help
```
```
$ pog foo
🍋 foo
🍋 node stuff/example-script
from example []
```
```
$ pog test --1312
🍋 test
🍋 echo "hello test" && npm run foo -- arg
hello test
> foo
> node stuff/example-script "arg" "--1312"
from example [ 'arg', '--1312' ]
```
> You can find the above scripts (including the one used in benchmarks) on [dum's repo](https://github.com/egoist/dum/).
#
## Contributing
1. Read the [Code of Conduct](https://github.com/GeopJr/pog/blob/main/CODE_OF_CONDUCT.md)
2. Fork it ( https://github.com/GeopJr/pog/fork )
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request
#
## Sponsors
[](https://github.com/sponsors/GeopJr)