diff --git a/Readme.md b/Readme.md index 828ec9122955f0064dbf01d0e711506fec944922..b62226aa1d7adc57e6395955ae10fb2100cd2047 100644 --- a/Readme.md +++ b/Readme.md @@ -53,12 +53,7 @@ To display the help of gblk run the following command: ```console $ gblk help -A tool used to link borg and git together - -This tool was created to link borg and git together and ease the management of developpment artifact -versionning using git - -gbl +gblk A tool used to link borg and git together USAGE: @@ -69,8 +64,11 @@ OPTIONS: SUBCOMMANDS: checkout Checkout results to the current git commit + clean This command cleans the .tmp repository of the project folder + clone Clones a repository given a destination commit Save the results folder of a git repository in an archive compact This command frees repository space by compacting segments + config This command can bed used to add gblk configuration create-hooks Create github hooks to use gbl automaticaly after commit, before and after checkout delete This command deletes an archive from the repository or the complete @@ -80,11 +78,16 @@ SUBCOMMANDS: help Print this message or the help of the given subcommand(s) init Initialize a borg repository inside a git project list List the content of the .borg archive - mount Mount an old file/directory from one or multiple archive named afert git - commits into the .mount folder inside de project directory + mount Mount an old file/directory from one or multiple archive named after git + commits into the .mount folder inside the project directory pre-co Check if a checkout can be performed without losing data prune This command prunes the .borg repository. This can be used to keep only archive created during a given time interval + pull This command can be used to pull a repository using a remote + push This command can be used to push a repository using a remote + remote This command can be used to add a new remote for push and pull commands + restore This command moves the borg folder .tmp/<PROJECT_DIR>_bkp folder into .borg + repository umount Unmount everything in the folder .mount ```