Permalink
Browse files

pared down the readme since all the docs are available with `fleet help`

  • Loading branch information...
1 parent ef20d1e commit 4c6bbb57ee9b8f0af60707e7b6eb5198c3419251 @substack committed Apr 12, 2012
Showing with 15 additions and 103 deletions.
  1. +15 −103 README.markdown
View
@@ -64,112 +64,24 @@ $ fleet ps
commands
========
-fleet remote
-------------
-
-This command creates and updates a file called `fleet.json` in your git project
-root so you don't need to type --hub and --secret all the time for the deploy,
-spawn, stop, and ps commands.
-
-### fleet remote add NAME=default --hub=HUB --secret=SECRET
-
-Register a remote with NAME and OPTIONS.
-
-Inspired by `git remote`.
-
-### fleet remote rm NAME
-
-Delete a remote.
-
-### fleet remote ls
-
-List the remotes from your `fleet.json`.
-
-fleet hub --port=PORT --secret=SECRET
--------------------------------------
-
-Create a new hub listening on a port with a secret passphrase.
-
-fleet drone --hub=HOST:PORT --secret=SECRET
--------------------------------------------
-
-Spin up a worker drone and connect to the hub.
-
-fleet deploy
-------------
-
-From a git directory, push the top commit from `git log` and check out the code
-on all the drones in an isolated directory based on the commit hash.
-
```
-$ fleet deploy
-deployed webapp/1b8050fcaf8f1b02b9175fcb422644cb67dc8cc5
-```
-
-fleet ps
---------
+Usage: fleet <command> [<args>]
-List the processes running on all the drones.
+The commands are:
+ deploy Push code to drones.
+ drone Connect to a hub as a worker.
+ exec Run commands on drones.
+ hub Create a hub for drones to connect.
+ monitor Show service events system-wide.
+ ps List the running processes on the drones.
+ remote Manage the set of remote hubs.
+ spawn Run services on drones.
+ stop Stop processes running on drones.
-```
-$ fleet ps
-drone#3dfe17b8
-├─┬ pid#1e99f4
-│ ├── status: running
-│ ├── commit: webapp/1b8050fcaf8f1b02b9175fcb422644cb67dc8cc5
-│ └── command: node server.js 8888
-└─┬ pid#d7048a
- ├── status: running
- ├── commit: webapp/1b8050fcaf8f1b02b9175fcb422644cb67dc8cc5
- └── command: node server.js 8889
+For help about a command, try `fleet help <command>`.
```
-fleet spawn OPTIONS -- command...
----------------------------------
-
-Spin up `command` on a random drone.
-
-You can control which drone by specifying `--drone=id`.
-
-Your spawned process will get the $REPO name, $COMMIT hash, $DRONE_ID, and
-$PROCESS_ID as environment variables from propagit.
-
-```
-$ fleet spawn -- node server.js 8888
-(spawned a25d7033#edc743)
-```
-
-fleet exec OPTIONS -- command...
---------------------------------
-
-Like `fleet spawn` except `command` doesn't restart itself and the output of the
-command is printed to the terminal.
-
-fleet stop id0 [id1, id2...]
-----------------------------
-
-Stop processes. Get each `id` by running `fleet ps`. It doesn't matter which
-drone the process is running on, fleet spams the request out to all the drones
-and ignores the request if the drone doesn't have the requested process id.
-
-Leading `'pid#'` strings are ignored on ids so you can more easily copy the pids
-from `fleet ps` output.
-
-```
-$ fleet stop 1e99f4 d7048a
-[3dfe17b8] stopped 1e99f4 d7048a
-```
-
-fleet monitor
--------------
-
-Show all spawn, exit, stdout, and stderr events happening everywhere across all
-of the drones.
+license
+=======
-```
-$ fleet monitor
-(spawned 3dfe17b8#1e99f4 : node server.js 8888)
-[3dfe17b8#1e99f4] listening on :8888
-(exited 3dfe17b8#751e9f : node server.js 8889)
-(spawned 3dfe17b8#d7048a : node server.js 8889)
-```
+MIT

0 comments on commit 4c6bbb5

Please sign in to comment.