diff options
| author | karissa <krmckelv@gmail.com> | 2016-05-24 11:44:00 -0700 |
|---|---|---|
| committer | karissa <krmckelv@gmail.com> | 2016-05-24 11:44:00 -0700 |
| commit | 593ec2096e9ce0a290809829ecd44f332c28e842 (patch) | |
| tree | bdfd4fd7ccfd386218c9bb35e5c280ee6afa7bed /api.md | |
| parent | 79ade9c827006bc7d4ed023a3c7716a4b82b3f04 (diff) | |
| parent | c2f993f1ddcf11a607ddfed4cb01676a16fd6263 (diff) | |
| download | dat-docs-593ec2096e9ce0a290809829ecd44f332c28e842.tar.gz dat-docs-593ec2096e9ce0a290809829ecd44f332c28e842.zip | |
Merge branch 'master' of github.com:datproject/docs
Diffstat (limited to 'api.md')
| -rw-r--r-- | api.md | 14 |
1 files changed, 6 insertions, 8 deletions
@@ -1,7 +1,5 @@ ## 1.0 Architecture Design - - * dat: command-line api * dat-desk: desktop application @@ -32,6 +30,10 @@ Starts serving dats in the background progress. * `--foreground`: run the server in the foreground instead. +#### `dat status` + +View a static list of the current dat links that are served. + #### `dat stop` Stops serving dats. @@ -40,10 +42,6 @@ Stops serving dats. Remove a link from the list, stops serving it. -#### `dat ls` - -View a static list of the current dat links that are served. - #### `dat mon` Opens up real-time monitoring panel for viewing progress of running dats. Can provide optional parameter `dat mon LINK` to filter the monitor and logs for a given dat link. @@ -82,9 +80,9 @@ linker.on('progress', function (progress) { }) ``` -#### `dat.join(link, cb)` +#### `dat.join(link, dir, cb)` -Join a swarm for the given link. Should be called after `link` or `download`. Throws error if data has not been downloaded or linked. +Joins the swarm for a given link to a given location. Get progress events from the stream. Progress events are the same as emitted by the `dat` object. ```js var done = function (err) { |