https://github.com/ruyadorno/redact
Small cli util that redacts path refs from stdin
https://github.com/ruyadorno/redact
Last synced: 17 days ago
JSON representation
Small cli util that redacts path refs from stdin
- Host: GitHub
- URL: https://github.com/ruyadorno/redact
- Owner: ruyadorno
- License: mit
- Created: 2021-04-20T20:22:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-20T21:14:07.000Z (about 4 years ago)
- Last Synced: 2025-02-12T19:48:47.678Z (2 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# redact
[](https://www.npmjs.com/@ruyadorno/redact)
[](https://github.com/ruyadorno/redact/blob/master/LICENSE)
[](https://github.com/ruyadorno/redact/actions?query=workflow%3Anode-ci)
Small cli util that redacts path refs from stdin.
It will also clean up:
- References to **node** executable path will be replaced with `node`
- Any `$HOME` env variable will be replaced with a literal string
- Normalize paths (windows `\\` will be replaced with `/`)
It can also be used with positional arguments to customize what word should be
redact and what should be the replacement text by default.
## Usage
You may install this package in the global system space and pipe any output
into `redact` for cleaned up output:
```sh
$ npm install -g @ruyadorno/redact
$ my_cmd | redact
```
OR alternatively, install+run on demand using `npm exec`:
```sh
$ my_cmd | npm exec @ruyadorno/redact
```
### Customizing
You may also customize what word to be redacted and define a new replacement
by providing additional positional arguments to `redact`, e.g:
```sh
$ my_cmd
Foo bar baz
$ my_cmd | redact bar REDACTED
Foo REDACTED baz
```
> Note: this might or might not be simpler than trying to remember `sed`'s syntax
## Example
Cleaning up your system path from **npm** logs so that you can better share
them with the world:
```sh
$ npm i 2>&1 --loglevel=verbose | redact
npm verb cli [
npm verb cli 'node',
npm verb cli '/main',
npm verb cli 'i',
npm verb cli '--loglevel=verbose'
npm verb cli ]
npm info using [email protected]
npm info using [email protected]
...
npm timing command:install Completed in 0ms
npm verb stack TypeError: Cannot read property 'bar' of undefined
npm verb stack at Install.install (/main/lib/install.js:113:40)
npm verb stack at Install.exec (/main/lib/install.js:108:10)
npm verb stack at Object.[_runCmd] (/main/lib/npm.js:116:12)
npm verb stack at /main/lib/npm.js:28:35
npm verb stack at Object. (/main/lib/cli.js:61:7)
npm verb cwd /main
npm verb Darwin 19.6.0
npm verb argv "node" "/main" "i" "--loglevel=verbose"
npm verb node v16.0.0
npm verb npm v7.10.0
npm ERR! Cannot read property 'bar' of undefined
npm verb exit 1
npm timing npm Completed in 198ms
npm verb code 1
npm ERR! A complete log of this run can be found in:
npm ERR! $HOME/.npm/_logs/2021-04-20T20_06_13_794Z-debug.log
```
## License
MIT