https://github.com/pranshuchittora/autarky

Liberating disk space from 📁 node_modules | Built with React
https://github.com/pranshuchittora/autarky

cli filesystem hacktoberfest javascript macbooks nodejs redux storage storage-manager typescript

Last synced: 1 day ago
JSON representation

Liberating disk space from 📁 node_modules | Built with React

• Host: GitHub
• URL: https://github.com/pranshuchittora/autarky
• Owner: pranshuchittora
• License: mit
• Created: 2019-06-07T16:24:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-30T18:41:43.000Z (about 1 year ago)
• Last Synced: 2024-12-14T15:08:08.426Z (9 days ago)
• Topics: cli, filesystem, hacktoberfest, javascript, macbooks, nodejs, redux, storage, storage-manager, typescript
• Language: TypeScript
• Homepage: https://autarky.js.org/
• Size: 49.5 MB
• Stars: 362
• Watchers: 4
• Forks: 8
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        






![npm](https://img.shields.io/npm/v/autarky)

![downloads](https://img.shields.io/npm/dm/autarky?style=flat)

![NPM](https://img.shields.io/npm/l/autarky)

[![Dependabot](https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot)](https://dependabot.com/)

[![Maintainability](https://api.codeclimate.com/v1/badges/ca50bed68e1c8f074c5f/maintainability)](https://codeclimate.com/github/pranshuchittora/autarky/maintainability)

![GitHub stars](https://img.shields.io/github/stars/pranshuchittora/autarky?style=social)










## Installation

```bash

# npm

npm i -g autarky

#yarn

yarn global add autarky

```

## Usage

```bash

$> autarky

```

## Why autarky

In today's world storage is comparatively costlier than compute. Majority of devs uses MacBooks and sadly MacBooks have pretty low storage (for base models). Hence filling up storage is quite often and we spend a lot of time picking stuff to be deleted.

### Motivation

It's 2019 and I got ran out of storage in my laptop after a thorough analysis I found out that the majority of the storage is occupied by `node_modules`. As each project have a separate node_modules (duplication despite the same version).

I also have a few projects which I touch once in a blue moon, hence they end up eating a lot of space. On the other hand, picking & removing `node_modules` manually is a tedious process. So I thought why not automate it.







### How it works

Autarky works by traversing all the child directories recursively relative to the current working directory (the place where you are executing autarky).

1. Enter the time in months. Node modules older than the given time will be shown.

2. Select the `node_modules` which you want to delete.

3. Confirm deletion.

4. Done! (No need to pay for more storage.)

---

## Internals

Autarky is built with the latest open source technologies.

1. UI - The user interface is written in React. Using the Ink's reconciler for rendering the react components.

2. State Management - The challenge of sharing data b/w UI and the process is achieved using Redux.

3. Heavy Computation - Large data crunching is done on child processes.

### Building Blocks

- [React](https://reactjs.org/)

- [Redux](https://redux.js.org/)

- [Ink](https://github.com/vadimdemedes/ink)

- [moment](https://momentjs.com/)

- [rimraf](https://github.com/isaacs/rimraf)

- [chalk](https://github.com/chalk/chalk)

---

Read [CONTRIBUTING Guide](./CONTRIBUTING.md)

License MIT

Author: Pranshu Chittora

[Github](https://github.com/pranshuchittora/)

[Twitter](https://twitter.com/pranshuchittora)

[LinkedIn](https://www.linkedin.com/in/pranshuchittora/)