Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(share): updated docs for share #199

Merged
merged 1 commit into from
Mar 26, 2022
Merged

fix(share): updated docs for share #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -925,6 +925,7 @@ Use share command to generate an authtoken that provides authorization to the ho
* --remotepath string Remote path to share
* --expiration-seconds number The seconds after which the ticket will expire(defaults to number of seconds in 90 days
if option not provided)
* --available-after Timelock for private file that makes the file available for download at certain time. 4 input formats are supported: +1h30m, +30, 1647858200 and 2022-03-21 10:21:38

`auth ticket` can be used with [download](#download), [commit](#commit) and [list](#list),
[meta](#get-metadata) and [get_download_cost](#download-cost), but only for files in
Expand All @@ -935,9 +936,10 @@ the pre-defined remote path.
| allocation | yes | allocation id | string |
| clientid | no | id of user to share file with, leave blank for public share | string |
| encryptionpublickey | no | public key of the client to share file with, required if clientId | string |
| expiration-seconds | no | seconds before `auth ticket` expires | int |
| expiration-seconds | no | seconds before `auth ticket` expires | int |
| remotepath | yes | remote path of file to share | string |
| revoke | no | revoke share for remote path | flag |
| revoke | no | revoke share for remote path | flag |
| available-after | no | timelock for private file that makes the file available for download at certain time. 4 input formats are supported: +1h30m, +30, 1647858200 and 2022-03-21 10:21:38. default value is current local time|string |

<details>
<summary>share</summary>
Expand Down
2 changes: 1 addition & 1 deletion cmd/share.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ func init() {
shareCmd.PersistentFlags().String("clientid", "", "ClientID of the user to share with. Leave blank for public share")
shareCmd.PersistentFlags().String("encryptionpublickey", "", "Encryption public key of the client you want to share with. Can be retrieved by the getwallet command")
shareCmd.PersistentFlags().Int64("expiration-seconds", 0, "Authticket will expire when the seconds specified have elapsed after the instant of its creation")
shareCmd.PersistentFlags().String("available-after", "", "Timelock for private file that makes the file available for download at certain time. 4 inputs are supported: +1h30m, +30, 1647858200 and 2022-03-21 10:21:38")
shareCmd.PersistentFlags().String("available-after", "", "Timelock for private file that makes the file available for download at certain time. 4 input formats are supported: +1h30m, +30, 1647858200 and 2022-03-21 10:21:38. Default value is current local time.")
shareCmd.PersistentFlags().Bool("revoke", false, "Revoke share for remotepath")
shareCmd.MarkFlagRequired("allocation")
shareCmd.MarkFlagRequired("remotepath")
Expand Down