gitsocket is a command line tool to help setup github / bitbucket webhook on your local machine. It helps you to do git based auto deploy.
For more information, please read the project website.
gitsocket is written in golang. It has only been tested and used on Linux. However, any POSIX environment (e.g. Mac OSX) with git and vi installed should be fine.
You need to install golang first.
Go into the folder. Build with this command:
go get ./...
go buildJust move it to any folder in your $PATH.
If you have properly install golang, setup $PATH to include
$GOPATH/bin, you may just use go get to install:
go get github.com/yookoala/gitsocketThe tool supports 4 commands:
Command:
gitsocket serverThis command creates a unix socket server. It updates the local git
repository to origin/master branch whenever there is socket input to
the socket file (default: ./gitsocket.sock).
You may change the remote repository name, branch or socket file path by the command options:
NAME:
server - socket server. listen to unix socket and update local git repository accordingly
USAGE:
command server [command options] [arguments...]
OPTIONS:
--remote, -r "origin" name of remote repository
--branch, -b "master" branch of remote repository
--listen, -l "./gitsocket.sock" path to socket to listen for connection
--pidfile, -p path to pidfile. empty for no pidfile
--output, -o log output of server. empty for displaying on stdout
--daemon, -d run server as daemon. will discard all output unless you have output flag set.
--gitrepo, -g targeting git repositoryCommand:
gitsocket onceThis command run as the server is triggered once
NAME:
once - run as the server is triggered once
USAGE:
command once [command options] [arguments...]
OPTIONS:
--remote, -r "origin" name of remote repository
--branch, -b "master" branch of remote repository
--output, -o log output of server. empty for displaying on stdout
--gitrepo, -g targeting git repositoryCommand:
gitsocket clientThis command connects to the gitsocket server and trigger one git checkout
NAME:
client - connects to socket triggers the socket server then returns the output
USAGE:
command client [command options] [arguments...]
OPTIONS:
--conn, -c "./gitsocket.sock" socket or address to connectCommand:
gitsocket setupThis command helps setup the post-checkout script file with vi. Just a time-saver in case you don't want to read all about git hook.
The script created will be run whenever git checkout is run. It will
be triggered after each time gitsocket server is triggered.
NAME:
setup - help setting up the post-checkout hook in the current repository folder. depends on vi
USAGE:
command setup [command options] [arguments...]
OPTIONS:
--command, -c Use shell command to be run in post-checkout hook. By default it starts vi to edit it. If the file exists, it fails (unless you have -f flag).
--force, -f Overwrites the current file with -c flag set. Default not set
--gitrepo, -g targeting git repositoryYou are welcomed to report issue of this software.
Please use our issue tracker to report problem.
This software is licensed under MIT license.
You can find a copy of the license in this repository.