delfin

README

Delfin

🐬 Command line tool for compress & decompress a folder.

Note

Delfin is in alpha-release so it may have some bugs. If you found a bug, please fork the project and send a pull request!

Installation

Check release page for binary files. Just download the file for your operating system and check with:

• Windows: .\delfin.exe version
• Linux/macOs: ./delfin version

If it works, you can add Delfin to the path now. If not go to the Compiling title.

Compiling

If you can't find a version for your operating system / cpu architecture, You can compile delfin yourself easily.

Pre-Requests

Make sure you have GO downloaded. For check run go version. If it works you already have GO in your computer. If not, download from official website.

Windows

Download the source code with git (git clone https://github.com/5elenay/delfin.git) or download zip and extract it. Now run these commands:

cd delfin
.\compile\win.bat

and it will compile Delfin now. When its finished it will run .\delfin.exe help for make sure it works.

Linux / MacOs

Its almost same with windows. Download the source code with git or download zip and extract it, Then run these commands:

cd delfin
./compile/other.sh

and it will compile Delfin now. When its finished it will run ./delfin help for make sure it works.

Commands

help

Shows all the commands. If you add an extra parameter it will show to extra informations about the command.

Usage

• delfin help
• delfin help <command>

Example(s)

delfin help

delfin help compress

version

Shows the version and github url.

Usage

• delfin version

Example

delfin version

compress

Compress a folder to .delfin format.

Usage

• delfin compress <folder location> <output location>

Example(s)

delfin compress ./example .

delfin compress ./example ./files

decompress

Decompress a .delfin file.

Usage

• delfin decompress <file location> <output location>

Example(s)

delfin decompress example.delfin .

delfin decompress example.delfin ./folders