release rc2 #476

karissa · Apr 26, 2016

implement new api https://github.com/datproject/docs/blob/master/api.md
tests for cli
update the docs in datproject/docs to reflect new usage.

10.0.0 updates API to use new one. I'm working on updating the CLI output here. We have a few lingering questions/updates on the sensible defaults:

Live or Static by default?

1a. Is the default the same for both download and sharing?
1b. When downloading & live, is it okay to seed by default too (otherwise no way to be live)?
Changed append to resume.
Currently if you reshare the same folder the hash will change. This is confusing, but is it acceptable for now?

joehand · Jun 7, 2016

10.0.0 updates API to use new one. I'm working on updating the CLI output here. We have a few lingering questions/updates on the sensible defaults:

Live or Static by default?

1a. Is the default the same for both download and sharing?
1b. When downloading & live, is it okay to seed by default too (otherwise no way to be live)?
Changed append to resume.
Currently if you reshare the same folder the hash will change. This is confusing, but is it acceptable for now?

@maxogden

1a. No strong feelings. @maxogden probably has input here. I do like the --live symmetry you get when uploading/downloading if static is default

1b. Defaults should not change based on the input. Always be static per default here.

+1 resume
I don't agree that 3 is confusing. It's just an opaque link. Either way this can be updated in the future.

One thing we should get in there asap the is dat.land links instead of just sharing the hash/public-key.

mafintosh · Jun 7, 2016

1a. No strong feelings. @maxogden probably has input here. I do like the --live symmetry you get when uploading/downloading if static is default

1b. Defaults should not change based on the input. Always be static per default here.

+1 resume
I don't agree that 3 is confusing. It's just an opaque link. Either way this can be updated in the future.

One thing we should get in there asap the is dat.land links instead of just sharing the hash/public-key.

I think the biggest prio here is finishing the CLI output so we can get rid of my console.logs. More 🚢 ing!

mafintosh · Jun 7, 2016

I think the biggest prio here is finishing the CLI output so we can get rid of my console.logs. More 🚢 ing!

I think 3 is confusing if the data hasn't changed but the hash changes. I think we have to decide: is the cli going to be more like dropbox (always live, always resume) or more like the older dat?

It could also be confusing because we are trying to do sync from the command line and maybe it just won't be a very nice interface.

+1 getting dat.land links in there!

karissa · Jun 7, 2016

I think 3 is confusing if the data hasn't changed but the hash changes. I think we have to decide: is the cli going to be more like dropbox (always live, always resume) or more like the older dat?

It could also be confusing because we are trying to do sync from the command line and maybe it just won't be a very nice interface.

+1 getting dat.land links in there!

What needs to happen to get dat.land links working across CLI/web? I can make them links but right now none would seed b/c the different swarms.

joehand · Jun 7, 2016

What needs to happen to get dat.land links working across CLI/web? I can make them links but right now none would seed b/c the different swarms.

@joehand

@joehand we need to run some hybrid clients. easiest way would be for dat.land to message a hybrid server somewhere to join the swarm for a specific hash.

mafintosh · Jun 7, 2016

@joehand we need to run some hybrid clients. easiest way would be for dat.land to message a hybrid server somewhere to join the swarm for a specific hash.

also anyone can run a hybrid server since you don't need to trust them. we'd only send them the discovery key which isn't enough to decrypt data.

mafintosh · Jun 7, 2016

also anyone can run a hybrid server since you don't need to trust them. we'd only send them the discovery key which isn't enough to decrypt data.

How does this look to everyone:

dat <command> <directory> [--option <argument>]
  dat share <directory>    creates a link and shares directory
  dat <link> <directory>   downloads data from a link into directory

options
  --live              sync new files and keep connection open
  --resume=<link>     resume a link created earlier
  --seed              when downloading, keep seeding data
  --port, -p          set a specific inbound tcp port
  --quiet, -q         quiet output mode
  --debug             debug output mode
  --no-color          no color output mode
  --version, -v       get installed dat version

joehand · Jun 8, 2016

How does this look to everyone:

dat <command> <directory> [--option <argument>]
  dat share <directory>    creates a link and shares directory
  dat <link> <directory>   downloads data from a link into directory

options
  --live              sync new files and keep connection open
  --resume=<link>     resume a link created earlier
  --seed              when downloading, keep seeding data
  --port, -p          set a specific inbound tcp port
  --quiet, -q         quiet output mode
  --debug             debug output mode
  --no-color          no color output mode
  --version, -v       get installed dat version

@joehand

@joehand

a "link" ... hmm... what kind of link ?
Let the user know a bit more information. about what a link is. url? uri? samba share?
describe "debug" and "quiet" and "no-color" mode telling what they do or don't do, rather then repeat the words.
"seed" ... hmm... it keeps seeding data ? why ? ...oh it keeps the data FOR seeding ? be a bit more clear here. English is a funky language when you put some words before or after others and changes the intent and meaning.

thadguidry · Jun 8, 2016

@joehand

a "link" ... hmm... what kind of link ?
Let the user know a bit more information. about what a link is. url? uri? samba share?
describe "debug" and "quiet" and "no-color" mode telling what they do or don't do, rather then repeat the words.
"seed" ... hmm... it keeps seeding data ? why ? ...oh it keeps the data FOR seeding ? be a bit more clear here. English is a funky language when you put some words before or after others and changes the intent and meaning.

"seed" ... hmm... it keeps seeding data ? why ? ...oh it keeps the data FOR seeding ?
This is a good point. "seeding" is both a noun and a verb.

waldoj · Jun 9, 2016

"seed" ... hmm... it keeps seeding data ? why ? ...oh it keeps the data FOR seeding ?
This is a good point. "seeding" is both a noun and a verb.

dat list might be nice, to view the contents of an archive.

laurengarcia · Jun 9, 2016

dat list might be nice, to view the contents of an archive.

<link> being listed as a "command" is confusing to me. What about calling it dat get <link> <directory> and mentioning dat <link> <directory> as a shorthand?

juliangruber · Jun 9, 2016

<link> being listed as a "command" is confusing to me. What about calling it dat get <link> <directory> and mentioning dat <link> <directory> as a shorthand?

It's also confusing me that some of the options apply to dat in general, like --version, some apply to all commands, like --port, and some only apply to specific commands.

What about splitting it up like this:

dat share <directory>
  --option1 description
  --option2 description

dat get <link> <directory>
  --option1 description
  --option2 description

general dat options:
  --option1 description
  --option2 description

juliangruber · Jun 9, 2016

It's also confusing me that some of the options apply to dat in general, like --version, some apply to all commands, like --port, and some only apply to specific commands.

What about splitting it up like this:

dat share <directory>
  --option1 description
  --option2 description

dat get <link> <directory>
  --option1 description
  --option2 description

general dat options:
  --option1 description
  --option2 description

+1 on julian's suggestions above^^, plus I'd like to see a dat get <link> --list option.

laurengarcia · Jun 9, 2016

+1 on julian's suggestions above^^, plus I'd like to see a dat get <link> --list option.

@waldoj

"seed" ... hmm... it keeps seeding data ? why ? ...oh it keeps the data FOR seeding ?

Yes, seed is a bit confusing. The two options for downloading are:

Download files and exit process after completion (thus stopping the sharing of files with peers)
Download files and keep process open, continuing to share files ("seed").

@waldoj @thadguidry would --share make more sense? Or would that be also confusing with the share command.

joehand · Jun 9, 2016

"seed" ... hmm... it keeps seeding data ? why ? ...oh it keeps the data FOR seeding ?

Yes, seed is a bit confusing. The two options for downloading are:

Download files and exit process after completion (thus stopping the sharing of files with peers)
Download files and keep process open, continuing to share files ("seed").

@waldoj @thadguidry would --share make more sense? Or would that be also confusing with the share command.

@juliangruber

Along with the options & wording, the defaults we are looking at:

Require user to specify a directory
Default to static (make --live option for share & get)

Updated w/ @juliangruber idea & other comments.

dat <command> <directory> [--option <argument>]
  dat share <directory>            creates a dat-link and shares directory
  dat get <dat-link> <directory>   downloads a dat-link into directory 

dat share <directory>
  --live                sync new files added to directory
  --resume=<dat-link>   resume a dat-link created previously
  --port, -p            set a specific inbound tcp port

dat get <dat-link> <directory>
  --live                download new files when added to dat-link source
  --list                print file list for dat-link
  --seed (?)            keep process open and share data with peers
  --port, -p            set a specific inbound tcp port

output options:
  --quiet, -q           output only dat-link, no progress information
  --debug               show debugging output
  --no-color            no color in output

general options (no command required):
  --version, -v         get installed dat version
  --doctor              run dat doctor

joehand · Jun 9, 2016

Along with the options & wording, the defaults we are looking at:

Require user to specify a directory
Default to static (make --live option for share & get)

Updated w/ @juliangruber idea & other comments.

dat <command> <directory> [--option <argument>]
  dat share <directory>            creates a dat-link and shares directory
  dat get <dat-link> <directory>   downloads a dat-link into directory 

dat share <directory>
  --live                sync new files added to directory
  --resume=<dat-link>   resume a dat-link created previously
  --port, -p            set a specific inbound tcp port

dat get <dat-link> <directory>
  --live                download new files when added to dat-link source
  --list                print file list for dat-link
  --seed (?)            keep process open and share data with peers
  --port, -p            set a specific inbound tcp port

output options:
  --quiet, -q           output only dat-link, no progress information
  --debug               show debugging output
  --no-color            no color in output

general options (no command required):
  --version, -v         get installed dat version
  --doctor              run dat doctor

@joehand

@joehand: I conclude the same thing that you did—that --seed isn't the problem, but the description was the problem. I think your revised description is much more clear.

waldoj · Jun 9, 2016

@joehand: I conclude the same thing that you did—that --seed isn't the problem, but the description was the problem. I think your revised description is much more clear.

@joehand

@joehand i found the first block confusing still, what about this? (also reworded the command descriptions slightly to match the rest)

dat share <directory>

  create a dat-link and share directory

  --live                sync new files added to directory
  --resume=<dat-link>   resume a dat-link created previously
  --port, -p            set a specific inbound tcp port

dat get <dat-link> <directory>

  download a dat-link into directory

  --live                download new files when added to dat-link source
  --list                print file list for dat-link
  --seed (?)            keep process open and share data with peers
  --port, -p            set a specific inbound tcp port

general options

  --version, -v         get installed dat version
  --doctor              run dat doctor
  --quiet, -q           output only dat-link, no progress information
  --debug               show debugging output
  --no-color            no color in output

juliangruber · Jun 9, 2016

@joehand i found the first block confusing still, what about this? (also reworded the command descriptions slightly to match the rest)

dat share <directory>

  create a dat-link and share directory

  --live                sync new files added to directory
  --resume=<dat-link>   resume a dat-link created previously
  --port, -p            set a specific inbound tcp port

dat get <dat-link> <directory>

  download a dat-link into directory

  --live                download new files when added to dat-link source
  --list                print file list for dat-link
  --seed (?)            keep process open and share data with peers
  --port, -p            set a specific inbound tcp port

general options

  --version, -v         get installed dat version
  --doctor              run dat doctor
  --quiet, -q           output only dat-link, no progress information
  --debug               show debugging output
  --no-color            no color in output

@joehand

@joehand +1 for "share".

thadguidry · Jun 9, 2016

@joehand +1 for "share".

Will be released soon...

joehand · Jun 17, 2016

Will be released soon...

karissa added this to the Priorities milestone Apr 26, 2016

joehand referenced this issue Jun 15, 2016
Closed
[Proposal] RC2 Live & Static CLI Output #484

joehand closed this Jun 17, 2016

joehand added a commit that referenced this issue Jun 17, 2016

Merge pull request #485 from joehand/dat-folder
Adds a .dat folder and updates to RC2 API (#476, #484)

Loading status checks…

771569f

datproject/dat

Join GitHub today

release rc2 #476

Comments

karissa commented Apr 26, 2016 • edited by joehand

karissa added this to the Priorities milestone Apr 26, 2016

This comment has been minimized.

joehand commented Jun 7, 2016

This comment has been minimized.

mafintosh commented Jun 7, 2016

This comment has been minimized.

mafintosh commented Jun 7, 2016

This comment has been minimized.

karissa commented Jun 7, 2016

This comment has been minimized.

joehand commented Jun 7, 2016

This comment has been minimized.

mafintosh commented Jun 7, 2016

This comment has been minimized.

mafintosh commented Jun 7, 2016

This comment has been minimized.

joehand commented Jun 8, 2016

This comment has been minimized.

thadguidry commented Jun 8, 2016 • edited

This comment has been minimized.

waldoj commented Jun 9, 2016

This comment has been minimized.

laurengarcia commented Jun 9, 2016 • edited

This comment has been minimized.

juliangruber commented Jun 9, 2016

This comment has been minimized.

juliangruber commented Jun 9, 2016

This comment has been minimized.

laurengarcia commented Jun 9, 2016

This comment has been minimized.

joehand commented Jun 9, 2016

This comment has been minimized.

joehand commented Jun 9, 2016

This comment has been minimized.

waldoj commented Jun 9, 2016

This comment has been minimized.

juliangruber commented Jun 9, 2016

This comment has been minimized.

thadguidry commented Jun 9, 2016

joehand referenced this issue Jun 15, 2016

This comment has been minimized.

joehand commented Jun 17, 2016

joehand closed this Jun 17, 2016

joehand added a commit that referenced this issue Jun 17, 2016

karissa commented Apr 26, 2016 •

edited by joehand

thadguidry commented Jun 8, 2016 •

edited

laurengarcia commented Jun 9, 2016 •

edited