Skip to content

Commit

Permalink
added README
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick Sweet committed Jul 28, 2012
1 parent b10d3f6 commit d408ee2
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 1 deletion.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.git*
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
synk
======

Quick and dirty way to sync up remote ec2 servers with your local code. Just cd in to your local project and run `sync`. If you dont already have a synk.json file for your project, synk will walk you through creating one. A synk.json file is just a json object that tells synk where your remote and local dirs are, the necessary info to rsync over ssh to your ec2 machine, and a series of commands that synk should run on the remote machine after upload to restart servers and what have you. Once your synk.json file is all set up, you can just run `synk` in you project to get your new code live in a few seconds.

usage
=====

````
Usage: synk [OPTIONS]
Options:
--remove, -rm Remove the synk.json config file
--config, -c Show synk.json config file
--help, -h Show this message
````

install
=======

```
npm install synk -g
```
3 changes: 2 additions & 1 deletion lib/synk.coffee
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ class Synk

for command, index in app.post_upload_command_sequence
ssh.stdin.write "#{command}\n"

if index is (app.post_upload_command_sequence.length - 1) and command not 'exit'
ssh.stdin.write 'exit\n'

options =
config_file: config
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "synk",
"preferGlobal": true,
"version": "0.0.02",
"description": "schronize a remote directory with a local one, then run a series of preset commands on the server",
"author": {
Expand Down

0 comments on commit d408ee2

Please sign in to comment.