# clean-ue4

> Simple npm script to clean Intermediate, Saved folders, and .pdbs from unreal projects and plugins for release prep.

Latest version **0.1.6** (published 2019-03-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install clean-ue4
pnpm add clean-ue4
yarn add clean-ue4
bun add clean-ue4
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2019-03-14 |
| First published | 2019-03-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | getnamo |
| Maintainers | getnamo |

## Links

- npm: https://www.npmjs.com/package/clean-ue4
- npm.io page: https://npm.io/package/clean-ue4

## Dependencies (3)

- [del](https://npm.io/package/del.md) ^4.0.0
- [colors](https://npm.io/package/colors.md) ^1.3.3
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Recent versions

- 0.1.6 (latest) — 2019-03-14
- 0.1.4 — 2019-03-14
- 0.1.3 — 2019-03-14
- 0.1.2 — 2019-03-14
- 0.1.1 — 2019-03-14
- 0.1.0 — 2019-03-14

## README

# clean-ue4
Simple npm script to clean Intermediate, Saved folders, and .pdbs from unreal projects and plugins for release preparation.

## Setup
1. Install [nodejs](https://nodejs.org/en/download/)
2. Navigate to ue4 project of choice and open a powershell window there

### via npm
3. ```npm i clean-ue4```
4. ```cd node_modules```
5. ```node clean-ue4``` this will give you usage instructions

### via git
3. ```git clone https://github.com/getnamo/clean-ue4.git```
4. ```cd clean-ue4```
5. ```npm i```
6. ```node clean-ue4``` this will give you usage instructions


## Usage

Format is

```node clean-ue4 --p <path>``` where path should only be ```auto``` unless you use ```-u```, then path can be anything.

You'll need one of the following options

#### Options
```-i``` for intermediate folders
```-s``` for saved folder
```-b``` for *.pdb files

e.g. for everything

```node clean-ue4 --p ../ -i -s -b```

You'll be prompted to confirm the delete patterns with a ```y``` or ```n```.

#### Other Options
##### Dry Run
To see what would've gotten deleted without doing it add ```-d``` which stands for dry run.

##### Auto-confirm
To auto-confirm delete prompt use ```-y```

##### Unrestricted project path
If you want to redirect script to another path you need to add ```-u``` to add unrestricted path mode (not recommended).

##### Lazy mode
If you're comfortable with the files it deletes

do
```node clean-ue4 -x```

I would recommend doing a dry run first...

```node clean-ue4 --x -d```

#### Very lazy mode
Click on the _FullCleanForRelease.bat_.

---
_Source: https://npm.io/package/clean-ue4 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
