Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 18 additions & 2 deletions docs/datasafed.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,30 @@
### Options

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-h, --help help for datasafed
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
-h, --help help for datasafed
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO

* [datasafed getconf](datasafed_getconf.md) - Get the value of the configuration item.
* [datasafed list](datasafed_list.md) - List contents of a remote directory or file.
* [datasafed mkdir](datasafed_mkdir.md) - Create an empty remote directory.
* [datasafed pull](datasafed_pull.md) - Pull remote file
* [datasafed push](datasafed_push.md) - Push file to remote
* [datasafed rm](datasafed_rm.md) - Remove one remote file, or all files in a remote directory.
Expand Down
17 changes: 16 additions & 1 deletion docs/datasafed_getconf.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,22 @@ datasafed getconf storage.access_key_id
### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down
27 changes: 21 additions & 6 deletions docs/datasafed_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ datasafed list /
# List one file and extract its size
datasafed list somefile.txt -o long | awk '{print $2}'

# List all files under the directory
datasafed list -r -f /some/dir
# List all files under the directory (ends with '/')
datasafed list -r -f /some/dir/

# List files modified within 1 hour and sort the result by size
datasafed list -r -f -s size --newer-than $(( $(date +%s) - 3600 )) /some/dir
datasafed list -r -f -s size --newer-than $(( $(date +%s) - 3600 )) /some/dir/

# List files with the name pattern
datasafed list --name "*.txt" /some/dir
datasafed list --name "*.txt" /some/dir/
```

### Options
Expand All @@ -38,13 +38,28 @@ datasafed list --name "*.txt" /some/dir
-o, --output-format string output format, choices: ["short" "long" "json"] (default "short")
-r, --recursive list recursively
--reverse reverse order
-s, --sort string sort by which field, choices: ["path" "size" "mtime"] (default "path")
-s, --sort string sort by which field, choices: ["path" "size" "mtime"], this option conflicts with --recursive
```

### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down
51 changes: 51 additions & 0 deletions docs/datasafed_mkdir.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## datasafed mkdir

Create an empty remote directory.

### Synopsis

Remove an empty remote directory.
Some storage backends, such as S3, do not have the concept of a directory, in which case the command will directly return success with no effect.

```
datasafed mkdir rpath [flags]
```

### Examples

```
# Create an empty directory
datasafed mkdir some/dir
```

### Options

```
-h, --help help for mkdir
```

### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO

* [datasafed](datasafed.md) - `datasafed` is a command line tool for managing remote storages.

17 changes: 16 additions & 1 deletion docs/datasafed_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,22 @@ datasafed pull some/path/file.txt - | wc -l
### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down
17 changes: 16 additions & 1 deletion docs/datasafed_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,22 @@ datasafed push - remote/path/somefile.txt
### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down
17 changes: 16 additions & 1 deletion docs/datasafed_rm.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,22 @@ datasafed rm -r some/path/to/dir
### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down
22 changes: 21 additions & 1 deletion docs/datasafed_rmdir.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Remove an empty remote directory.

### Synopsis

Remove an empty remote directory.
Some storage backends, such as S3, do not have the concept of a directory, in which case the command will directly return success with no effect.

```
datasafed rmdir rpath [flags]
```
Expand All @@ -22,7 +27,22 @@ datasafed rmdir some/dir
### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down
21 changes: 18 additions & 3 deletions docs/datasafed_stat.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ datasafed stat [--json] rpath [flags]
# Stat a file
datasafed stat path/to/file.txt

# Stat a directory with json output
datasafed stat -json path/to/dir
# Stat a directory (ends with '/') with json output
datasafed stat -json path/to/dir/
```

### Options
Expand All @@ -30,7 +30,22 @@ datasafed stat -json path/to/dir
### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down
17 changes: 16 additions & 1 deletion docs/datasafed_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,22 @@ datasafed version
### Options inherited from parent commands

```
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
-c, --conf string config file (default "/etc/datasafed/datasafed.conf")
--console-log Enable console log
--console-timestamps Log timestamps to stderr. (default true)
--disable-color Disable color output
--file-log-level string File log level (default "debug")
--file-log-local-tz When logging to a file, use local timezone
--force-color Force color output
--json-log-console JSON log file
--json-log-file JSON log file
--log-dir string Directory where log files should be written.
--log-dir-max-age duration Maximum age of log files to retain (default 720h0m0s)
--log-dir-max-files int Maximum number of log files to retain (default 100)
--log-dir-max-total-size-mb float Maximum total size of log files to retain (default 1000)
--log-file string Override log file.
--log-level string Console log level (default "info")
--max-log-file-segment-size int Maximum size of a single log file segment (default 50000000)
```

### SEE ALSO
Expand Down