1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
README of git-ftp
=================
* This application is licenced under [GNU General Public License, Version 3.0]
* Follow this project on twitter [@gitftp](https://twitter.com/gitftp)
Summary
-------
Git powered FTP client written as shell script.
About
-----
I use git-ftp for my script based projects, mostly PHP. Most of the low-cost
web hosting companies do not provide SSH or git support, but only FTP.
That is why I needed an easy way to deploy my git tracked projects. Instead of
transfering the whole project, I thought, why not only transfer the files
that changed since the last time, git can tell me those files.
Even if you are playing with different branches, git-ftp knows which files
are different. No ordinary FTP client can do that.
Known Issues
------------
* See [git-ftp issues on GitHub] for open issues
Installing
----------
See [INSTALL](INSTALL.md) file.
Usage
-----
$ cd my_git_tracked_project
$ git ftp push --user <user> --passwd <password> ftp://host.example.com/public_html
For interactive password prompt use:
$ git ftp push -u <user> -p - ftp://host.example.com/public_html
Pushing for the first time:
$ git ftp init -u <user> -p - ftp://host.example.com/public_html
See [man page](man/git-ftp.1.md) for more options, features and examples!
Limitations
-----------
* Windows and OS X: I am very limited in testing on Windows and OS X. Thanks for helping me out fixing bugs on these platforms.
* git-ftp as deployment tool: git-ftp was not designed as centralized deployment tool. While running git-ftp, you have to take care, no one pushes or touches this repo (e.g. no commits, no checkouts, no file modifications)!
Unit Tested
-----------
Core functionality is unit tested on Linux using shunit2. You can find the tests in `tests/`.
Contributions
-------------
Don't hesitate to use GitHub to improve this tool. Don't forget to add yourself to the [AUTHORS](AUTHORS) file.
[git-ftp issues on GitHub]: http://github.com/git-ftp/git-ftp/issues
[GNU General Public License, Version 3.0]: http://www.gnu.org/licenses/gpl-3.0-standalone.html
|