https://github.com/txchen/ncdus3
Scan S3 S3 buckets and generate ncdu feed
https://github.com/txchen/ncdus3
Last synced: 9 months ago
JSON representation
Scan S3 S3 buckets and generate ncdu feed
- Host: GitHub
- URL: https://github.com/txchen/ncdus3
- Owner: txchen
- License: mit
- Created: 2019-04-19T16:23:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-15T22:44:45.000Z (about 7 years ago)
- Last Synced: 2025-08-09T11:49:29.911Z (11 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ncdus3
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ncdus3
Inspired by [ncdu-s3](https://github.com/EverythingMe/ncdu-s3), and generate smaller ncdu feed by default.
## Install
```bash
# nodejs v10+ is required
npm i -g ncdus3
```
To view the output json file, you also need to install [ncdu](https://dev.yorhel.nl/ncdu).
## Usage
```bash
# first, make sure you can access s3 in your terminal environment.
# then run this tool
ncdus3
# example:
ncdus3 s3://mybucket/some/path output.json
# by default, ncdus3 will combine files to generate smaller feed
# you can also turn it off
ncdus3 s3://mybucket/some/path output.json --no-combine
# once it is done, view the result with ncdu
ncdu -f output.json
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D