Skip to content
Command line tool for nuking a directory
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
nuke
tests formatting and linting May 16, 2019
.gitignore
.travis.yml
DEV.md
HISTORY.md
LICENSE Initial commit Mar 24, 2017
Makefile
Pipfile
Pipfile.lock
README.md
requirements.txt
setup.cfg config file so we always generate a universal wheel Mar 26, 2017
setup.py
tox.ini

README.md

Nuke

version license wheel python Build Status say-thanks

Command line tool for nuking a directory 💥.

Installation

Installing nuke is intended to be super easy. The only dependency is a supported Python interpreter. You can get nuke via pip:

$ pip install nuke

nuke is supported for Python versions 2.7, 3.5 & 3.6+.

Usage

The most common usage of nuke is when you wish to recreate a build directory for a build program such as CMake.

To use nuke, you just call :code:nuke from the command line and specify the directory you wish to nuke:

$ nuke path/to/directory

If you are already in the directory you wish to nuke, you don't need to exit the directory. Calling :code:nuke without any arguments will nuke the current directory:

$ nuke  # same as "nuke ."

Since nuking is a dangerous operation and you don't want to inadvertently delete something important, nuke always asks you to confirm the nuking of a directory. If you wish to override this since you know what you are doing or you wish to use nuke in a shell script, you can pass in the -y flag:

$ nuke -y /path/to/dir/

You can also specify a .nukeignore file inside the directory to be nuked. This works similar to the .gitignore file. Every file that matches a pattern in the .nukeignore is ignored and spared from a gruesome fate of its eligible siblings.

For example:

*.py

will result in all .py files not being nuked.

Suppose you just want to see what files will be nuked without actually deleting them, you can then run nuke -l /path/to/dir, and this will print out the directory tree of all the files that will be nuked.

You can’t perform that action at this time.