Handbook

1. Synopsis

gitl [-V][-h][-d]  Commands [args] 

**Gitlocker Commands**

Init Remote Transparent Encryption
            init       Initialize the remote transparent encryption key
            
encrypt or decrypt files/folders
            encrypt    encryption file/folder
            decrypt    decrypt file/folder
            status     show file/folder status 

OPTIONS
        -V Show soft version.
        -h Show help info.
        -d Set the git workspace folder(That contain .git), applicable to all commands.            

2. Description

2.1 init

Encryption Initialization

NAME:
        gitl-init - Initialize the encryption key with password

SYNOPSIS
        gitl init [-p your_password][-k key_file][-c][-i] 

DESCRIPTION
        When using gitl for the first time, it is necessary to initialize and generate 
        a key file(-p or -k), which will be used to encrypt the data. The key file can be exported 
        using the exportkey command.
        When you do not need gitl, use the -c option to clear all encryption configurations.

OPTIONS
        -p Gitl employs PBKDF2 algorithm  to process your password, 
           generating a sufficiently secure key to encrypt your files.
        -k Specify the key file path (exported by gitl exportkey).
        -c Clear all encryption configurations, and restore the git repository to an unencrypted state.
        -i An indicator is displayed when there are files that need to be decrypted.

2.2 encrypt

Encrypt your files in git workspace:

NAME:
        gitl-encrypt - Encrypt a file or directory

SYNOPSIS
        gitl encrypt file/folder [-I][-E][-i] 

DESCRIPTION
        Encrypt the files of the git repository.

OPTIONS
        -I Only encrypt files with specified extensions in the directory, 
           use semicolons to separate multiple file extensions, for example, "cpp;h;c".
        -E Exclude files with specified extensions in the directory, use semicolons 
           to separate multiple file extensions, for example, "obj;a;so". -I and -E cannot 
           be used simultaneously.
        -i Show indicator.

2.3 decrypt

Decrypt your files in git workspace:

NAME:
        gitl-encrypt - Decrypt a file or directory

SYNOPSIS
        gitl decrypt file/folder [-I][-E][-i] 

DESCRIPTION
        decrypt the files of the git repository 

OPTIONS
        -I Only decrypt files with specified extensions in the directory, 
           use semicolons to separate multiple file extensions, for example, "cpp;h;c".
        -E Exclude files with specified extensions in the directory, use semicolons 
           to separate multiple file extensions, for example, "obj;a;so". -I and -E cannot 
           be used simultaneously.
        -i Show indicator.

2.4 status

Show Encryption status:

NAME:
        gitl-status - Encrypt information

SYNOPSIS
        gitl status file/folder

DESCRIPTION
        Display the encryption information of the file/folder 
        

2.5 exportkey

Export the encryption key for unlocking operations:

NAME:
        gitl-exportkey - Export the key

SYNOPSIS
        gitl exportkey keypath

DESCRIPTION
        Export key for 'gitl init' 

3. Configuration file .gitlconf

.gitlconf is a configuration file placed in the git workspace, currently supporting the "include" and "exclude" fields, corresponding to the command line options -I and -E (command line takes precedence). The file format is as follows:

   [config]
   include=c;cxx

"include" and "exclude" fields cannot be used simultaneously.