jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2026-01-03 17:13:18 +00:00
Code Issues Projects Releases Wiki Activity

docs: add description to commands and index page

Browse Source
This commit is contained in:
Nick Craig-Wood
2020-05-16 15:11:55 +01:00
parent d6c31b51c6
commit 6d19bbba73
73 changed files with 525 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/content/commands/rclone_lsjson.md
View File

@@ -1,6 +1,7 @@
---
date: 2020-02-10T12:28:36Z
date: 2020-05-18T10:38:09+01:00
title: "rclone lsjson"
description: "List directories and objects in the path in JSON format."
slug: rclone_lsjson
url: /commands/rclone_lsjson/
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsjson/ and as part of making a release run "make commanddocs"
@@ -35,17 +36,25 @@ The output is an array of Items, where each Item looks like this
"Tier" : "hot",
}
If --hash is not specified the Hashes property won't be emitted.
If --hash is not specified the Hashes property won't be emitted. The
types of hash can be specified with the --hash-type parameter (which
may be repeated). If --hash-type is set then it implies --hash.
If --no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request (eg s3, swift).
If --no-modtime is specified then ModTime will be blank. This can
speed things up on remotes where reading the ModTime takes an extra
request (eg s3, swift).
If --no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra request (eg s3, swift).
If --no-mimetype is specified then MimeType will be blank. This can
speed things up on remotes where reading the MimeType takes an extra
request (eg s3, swift).
If --encrypted is not specified the Encrypted won't be emitted.
If --dirs-only is not specified files in addition to directories are returned
If --dirs-only is not specified files in addition to directories are
returned
If --files-only is not specified directories in addition to the files will be returned.
If --files-only is not specified directories in addition to the files
will be returned.
The Path field will only show folders below the remote path being listed.
If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt"
@@ -97,15 +106,16 @@ rclone lsjson remote:path [flags]
### Options
```
--dirs-only Show only directories in the listing.
-M, --encrypted Show the encrypted names.
--files-only Show only files in the listing.
--hash Include hashes in the output (may take longer).
-h, --help help for lsjson
--no-mimetype Don't read the mime type (can speed things up).
--no-modtime Don't read the modification time (can speed things up).
--original Show the ID of the underlying Object.
-R, --recursive Recurse into the listing.
--dirs-only Show only directories in the listing.
-M, --encrypted Show the encrypted names.
--files-only Show only files in the listing.
--hash Include hashes in the output (may take longer).
--hash-type stringArray Show only this hash type (may be repeated).
-h, --help help for lsjson
--no-mimetype Don't read the mime type (can speed things up).
--no-modtime Don't read the modification time (can speed things up).
--original Show the ID of the underlying Object.
-R, --recursive Recurse into the listing.
```
See the [global flags page](/flags/) for global options not listed here.