Skip to content

Home

Jump to bottom
archexpert edited this page Feb 27, 2018 · 3 revisions

TEMPest

TEMPest is a tool to manage easily temporary folders/files

Build Status Donate

Installation

From source (Github)

Requirements

  • git
  • go (golang)

Command

go get -v -u github.com/ChacaS0/tempest

Initialization

Command line init

It is very easy to use.
First, to initialize it the first time, run:

> tempest init

This will generate a ~/.tempestcf file. It will hold the list of all the temp directories.

If there is an issue and the file can't be created somehow, you can still create it at its default location: $HOME/.tempestcf and leave it empty for now.

This will also generate a ~/.tempest.yaml file. It will hold the configuration of TEMPest.

If there is an issue and the file can't be created somehow, you can still crate it at its default location: $HOME/.tempest.yaml with default content:

duration: 5
auto-mode: false

Parameters:

  • duration : This is the maximum age the content of the temp directories, choose it carefully!

You have to choose a duration greater than 1, it is for your own safety!!

Add a new temp folder to the list

To add the current directory

Positionate yourself to the deried directory. For example, if you want to add /tmp, use this instructions:

$ cd /temp
$ tempest add

Through command-line

Just run:

tempest add ...<PATH>
  • <PATH> being the path to the directory to be added to the list of temp directories
  • ... meaning that many arguments can be passed

By convention we will give the name temp to the directories to be added to tempest

Through text editor

Just open ~/.tempestcf and add a new line with the absolute path of the temp directory to be added.

List the current directories added to TEMPest

Using TEMPest

$ tempest list

Viewing the file ~/.tempestcf

$ cat ~/.tempestcf
Or
$ vi ~/.tempestcf

Updating TEMPest

$ tempest update

Runing a global purge

The age of the files deleted will be the one older than the number of days set as "duration" in ~/.tempest.yaml

Test mode

In this mode, it will display the file it would delete plus the size.
Nothing gets deleted. To do so, try:

$ tempest start -t

Real one

Runing this will actually delete files/directories, make sure everything inside ~/.tempestcf is meant to be there with tempest list first.

$ tempest start

Purging one directory

Still based on the config file

It is possible to purge a directory even if it is not added to tempest. There is also a test mode for this one.

Test mode

$ tempest purge -p <PATH> -t
  • <PATH> is the path you want to purge
  • -t declare the test mode

Real one

$ tempest purge -p <PATH>
  • <PATH> is the path you want to purge

Access the documentation (usage)

It is recommanded to have Showdown installed. If you don't but are interested, checkout this link.

$ tempest doc

There is also a "man like" view of the documentation.

$ tempest doc -m

Thanks to

Clone this wiki locally