TK Tools

Contributers: Mick Mifsud

Modified: 3 years ago

Page Permission: Public - Revision: 783

 

Tk Tools have been developed to help with repository updates, DB backups, releasing projects and a lot more.

To install the Tk Tools to a server. Checkout the code at https://github.com/tropotek/tk-tools. You can follow the instructions to get the tools to work from the Linux command line.

$ tk 
Tropotek Command Utilities 3.2.2

Usage:
 command [options] [arguments]

Options:
 -h, --help            Display this help message
 -q, --quiet           Do not output any message
 -V, --version         Display this application version
     --ansi            Force ANSI output
     --no-ansi         Disable ANSI output
 -n, --no-interaction  Do not ask any interactive question
 -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
 branchShow  [branches|bs] Run from the root of a ttek project.
 commit      [ci] Run from the root of a ttek project to commit the code and ttek lib changes.
 dbBackup    [db] Backup all tables in a DB
 dbRestore   [dbr] Restore Databases backed up with the tkDbBackup command
 hash        Generate a hash value. (i.e. "md5", "sha256", "haval160,4", etc..)
 help        Displays help for a command
 list        Lists commands
 passGen     [pg] Generate Temporary password for projects
 status      [st] Run from the root of a ttek project to get the status of the lib and it vendor libs.
 sync        [syn] Use this script to backup all sites and DB to a folder
 tag         Tag and release a repository.
 tagProject  [tp] Tag a release from the repository.
 tagShow     [tags|ts] Run from the root of a ttek project.
 update      [up] Run from the root of a ttek project to update the repository.

update

Update/fetch a project and all libs from the git repositories.

commit

Commit a project and all libs to their respective repositories.

tag

Tag a release of the project and all modified libs. This only tags libs that have changed since the last taged version

branchShow

This shows the current checked out base branch of each project. Handy to see what dev version you have checked out and are working on.

To see all the base branches of the project and managed libs, run the "tk bs" command from the base folder of a project and you will see something like this:

$ tk bs 
ttek/tk-ems               3.8          
ttek/tk-form              3.0          
ttek/tk-domtemplate       3.0          
ttek/tk-uni               3.4          
ttek/tk-mvc               3.2          
ttek/tk-base              3.2          
ttek/tk-framework         3.0          
ttek/tk-database          3.2          
ttek/tk-table             3.0          
ttek/tk-auth              3.0          
ttek/tk-map               3.0          
ttek/tk-ui                3.0          
ttek/tk-installers        3.0          
ttek/tk-plugin            3.2          
ttek/tk-mail              3.0        

 

tagShow

To see what the current tags of all libs and the project use "tk tags":

/ems$ tk tags 
package                   curr         next         
ttek/tk-ems               3.9.64       3.9.66       
ttek/tk-form              3.0.112                   
ttek/tk-domtemplate       3.0.34                    
ttek/tk-uni               3.4.110                   
ttek/tk-mvc               3.2.26                    
ttek/tk-base              3.2.138                   
ttek/tk-framework         3.0.96                    
ttek/tk-database          3.2.48                    
ttek/tk-table             3.0.118                   
ttek/tk-auth              3.0.10                    
ttek/tk-map               3.0.8                     
ttek/tk-ui                3.0.86                    
ttek/tk-installers        3.0.22                    
ttek/tk-plugin            3.2.8                     
ttek/tk-mail              3.0.24                    
ttek-plg/plg-skill        3.0.82                    
ttek-plg/plg-ca           3.2.46       3.2.48       
ttek-plg/plg-rating       3.0.30                    
ttek-plg/plg-coa          3.0.20                    
ttek-plg/plg-ldap         3.2.8                     
ttek-plg/plg-animal       3.0.14       3.0.16       
ttek-plg/plg-ruleset      3.2.16       3.2.18      

this shows the current tags and the next tagged name that will be used when you use the "tk tag" command to tag the project and all changed libs. next will not show until you have committed your changes using the "tk ci" command.