diff options
| author | Max Ogden <max@maxogden.com> | 2016-08-05 12:36:08 -0700 |
|---|---|---|
| committer | Max Ogden <max@maxogden.com> | 2016-08-05 12:36:08 -0700 |
| commit | 416108575f8207d687c52ca079117bcc5cfdb515 (patch) | |
| tree | a6b6a2d5624b8edcbb6e4542714785f91e581649 /docs/api.md | |
| parent | 6879daedad2d53e32d1d9d7bf8b1c74574bc28ef (diff) | |
| parent | ffb465bb3bcebb62c5e63cc3ed80d70274848deb (diff) | |
| download | dat-docs-416108575f8207d687c52ca079117bcc5cfdb515.tar.gz dat-docs-416108575f8207d687c52ca079117bcc5cfdb515.zip | |
Merge branch 'master' of https://github.com/datproject/docs
Diffstat (limited to 'docs/api.md')
| -rw-r--r-- | docs/api.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..68a7c3f --- /dev/null +++ b/docs/api.md @@ -0,0 +1,29 @@ +## 1.0 Architecture Design + + + * dat: command-line api + * dat-desk: desktop application + * hyperdrive: storage layer + * discovery-swarm: dat network swarm discovery mechanism + +## dat + +Command-line interface for dat + +#### `dat share DIR` + +Create a new dat link for the contents of the given directory. Prints a URL, which is a unique public key feed. This public key feed can be appended to. + +###### Options + + * `--append=URL`: Adds the new URL to the public key feed. + * `--static`: Ensures that the URL cannot be appended to. + +#### `dat URL DIR` + +Downloads the link to the given directory, and then exits. + +###### Options + + * `--seed`: Downloads the link to the given directory and opens up a server that seeds it to the dat peer network. + * `--list`: Fetches the metadata for the link and prints out the file list in the console. |