chacas0 / tempest

TEMPest is a tool (CLI) that helps to handle, manage and act on temporary directories

TEMPest

TEMPest is a tool to manage easily temporary folders/files

Index

• Installation
  • From source
    • Requirements
    • Command
    • Temporarily GOBIN
• Initialization
  • Command line init
  • Parameters
• Add a new temp folder to the list
  • To add the current directory
    • Through command-line
    • Through text editor
• List the current directories added to TEMPest
  • Using TEMPest
  • Viewing the file .tempestcf
• Runing a global purge
  • Test mode
  • Real one
• Purging one directory
  • Test mode
  • Real one
• Access the documentation

Installation

From source (Github)

Requirements

• git
• go (golang)

Command

First choose if you want to add permanantly GOBIN to your PATH

GOBIN temporarily in PATH

export GOBIN=/bin

or

export GOBIN=/usr/bin

You can also skip this step and then just add a symlink from $GOBIN/tempest to /usr/bin/tempest after the installation of TEMPest

Then

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

GOBIN permanently in PATH

Add this line to /etc/environment:

GOBIN=<PATH_OF_YOUR_CHOICE>
PATH=$PATH:$GOBIN

Then

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 in $HOME/.tempest.

It will hold the list of all the targets.

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

This will also generate a $HOME/.tempest/.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/.tempest.yaml with default content:

duration: 5
auto-mode: false

Parameters:

• duration : This is the maximum age the content of the target's content, choose it carefully!

You have to choose a duration greater than 1 !!

Add a new target 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

With command-line

Just run:

tempest add ...<PATH>

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

By convention we will give the name temp.est to the directories to be added to TEMPest

With a text editor

Just open $HOME/.tempest/.tempestcf and add a new line with the absolute path of the target to be added.

List the current directories added to TEMPest

Using TEMPest

$ tempest list

Viewing the file $HOME/.tempest/.tempestcf

$ cat $HOME/.tempest/.tempestcf
Or
$ vi $HOME/.tempest/.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 $HOME/.tempest/.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 $HOME/.tempest/.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

More

If you want to know more about TEMPest, visit this page.

---