File Download Command

V4.0.2

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --no-progress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --source-server-side-encryption=SSE-C. The default algorithm is set to AES256 which you can change with the --source-server-side-encryption-algorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 file download [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--no-progress] [--source-server-side-encryption {SSE-C}]
                 [--source-server-side-encryption-algorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file, for example, b2://yourBucket/file.txt or b2id://fileId.
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --no-progress
  Progress will not be reported.
  Default: False
• --source-server-side-encryption
  Possible values: SSE-C
• --source-server-side-encryption-algorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V4.0.1

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --no-progress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --source-server-side-encryption=SSE-C. The default algorithm is set to AES256 which you can change with the --source-server-side-encryption-algorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 file download [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--no-progress] [--source-server-side-encryption {SSE-C}]
                 [--source-server-side-encryption-algorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file, for example, b2://yourBucket/file.txt or b2id://fileId.
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --no-progress
  Progress will not be reported.
  Default: False
• --source-server-side-encryption
  Possible values: SSE-C
• --source-server-side-encryption-algorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V4.0.0

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --no-progress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --source-server-side-encryption=SSE-C. The default algorithm is set to AES256 which you can change with the --source-server-side-encryption-algorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 file download [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--no-progress] [--source-server-side-encryption {SSE-C}]
                 [--source-server-side-encryption-algorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file, for example, b2://yourBucket/file.txt or b2id://fileId.
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --no-progress
  Progress will not be reported.
  Default: False
• --source-server-side-encryption
  Possible values: SSE-C
• --source-server-side-encryption-algorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.19.1

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --no-progress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --source-server-side-encryption=SSE-C. The default algorithm is set to AES256 which you can change with the --source-server-side-encryption-algorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--no-progress] [--source-server-side-encryption {SSE-C}]
                 [--source-server-side-encryption-algorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --no-progress
  Progress will not be reported.
  Default: False
• --source-server-side-encryption
  Possible values: SSE-C
• --source-server-side-encryption-algorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.19.0

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --no-progress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --source-server-side-encryption=SSE-C. The default algorithm is set to AES256 which you can change with the --source-server-side-encryption-algorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--no-progress] [--source-server-side-encryption {SSE-C}]
                 [--source-server-side-encryption-algorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --no-progress
  Progress will not be reported.
  Default: False
• --source-server-side-encryption
  Possible values: SSE-C
• --source-server-side-encryption-algorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.18.0

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --no-progress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --source-server-side-encryption=SSE-C. The default algorithm is set to AES256 which you can change with the --source-server-side-encryption-algorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--no-progress] [--source-server-side-encryption {SSE-C}]
                 [--source-server-side-encryption-algorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --no-progress
  Progress will not be reported.
  Default: False
• --source-server-side-encryption
  Possible values: SSE-C
• --source-server-side-encryption-algorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.17.0

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --noProgress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --sourceServerSideEncryption=SSE-C. The default algorithm is set to AES256 which you can change with the --sourceServerSideEncryptionAlgorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--noProgress] [--sourceServerSideEncryption {SSE-C}]
                 [--sourceServerSideEncryptionAlgorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --noProgress
  Progress will not be reported.
  Default: False
• --sourceServerSideEncryption
  Possible values: SSE-C
• --sourceServerSideEncryptionAlgorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.16.1

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --noProgress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --sourceServerSideEncryption=SSE-C. The default algorithm is set to AES256 which you can change with the --sourceServerSideEncryptionAlgorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--noProgress] [--sourceServerSideEncryption {SSE-C}]
                 [--sourceServerSideEncryptionAlgorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --noProgress
  Progress will not be reported.
  Default: False
• --sourceServerSideEncryption
  Possible values: SSE-C
• --sourceServerSideEncryptionAlgorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.16.0

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --noProgress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --sourceServerSideEncryption=SSE-C. The default algorithm is set to AES256 which you can change with the --sourceServerSideEncryptionAlgorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--noProgress] [--sourceServerSideEncryption {SSE-C}]
                 [--sourceServerSideEncryptionAlgorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --noProgress
  Progress will not be reported.
  Default: False
• --sourceServerSideEncryption
  Possible values: SSE-C
• --sourceServerSideEncryptionAlgorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.15.0

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --noProgress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --sourceServerSideEncryption=SSE-C. The default algorithm is set to AES256 which you can change with the --sourceServerSideEncryptionAlgorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--noProgress] [--sourceServerSideEncryption {SSE-C}]
                 [--sourceServerSideEncryptionAlgorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --noProgress
  Progress will not be reported.
  Default: False
• --sourceServerSideEncryption
  Possible values: SSE-C
• --sourceServerSideEncryptionAlgorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

V3.14.0

This command downloads the given file and stores it in the given local file.

If the tqdm library is installed, the progress bar is displayed on standard error (stderr). Without it, simple text progress is printed. Use --noProgress to disable progress reporting. This may marginally improve performance.

Use the –-threads parameter to manually adjust the number of threads that are used in the operation. Otherwise, the number of threads is automatically chosen.

To access SSE-C encrypted files, set the parameter --sourceServerSideEncryption=SSE-C. The default algorithm is set to AES256 which you can change with the --sourceServerSideEncryptionAlgorithm parameter. Using SSE-C requires that you provide the B2_SOURCE_SSE_C_KEY_B64 environment variable that contains the base64-encoded encryption key.

Use the –-write-buffer-size parameter to set the size (in bytes) of the buffer that is used to write files.

Use the –-skip-hash-verification parameter to disable a hash check on downloaded files.

Use the –-max-download-streams-per-file parameter to set a maximum number of streams for a parallel downloader.

b2 download-file [-h] [--threads THREADS]
                 [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE]
                 [--noProgress] [--sourceServerSideEncryption {SSE-C}]
                 [--sourceServerSideEncryptionAlgorithm {AES256}]
                 [--write-buffer-size BYTES] [--skip-hash-verification]
                 B2_URI localFileName

Required Capabilities

• readFiles

Positional Arguments

• B2_URI
  Points to a file (for example, b2://yourBucket/file.txt or b2id://fileId).
• localFileName

Named Arguments

• --threads
• --max-download-streams-per-file
• --noProgress
  Progress will not be reported.
  Default: False
• --sourceServerSideEncryption
  Possible values: SSE-C
• --sourceServerSideEncryptionAlgorithm
  Possible choices: AES256
  Default: “AES256”
• --write-buffer-size
• --skip-hash-verification
  Default: False

This command is not included in version 2.1.0.

This command is not included in version 2.2.0.

This command is not included in version 2.3.0.

This command is not included in version 2.4.0.

This command is not included in version 2.5.0.

This command is not included in version 2.5.1.

This command is not included in version 3.0.0.

This command is not included in version 3.0.1.

This command is not included in version 3.0.2.

This command is not included in version 3.0.3.

This command is not included in version 3.1.0.

This command is not included in version 3.2.0.

This command is not included in version 3.2.1.

This command is not included in version 3.3.0.

This command is not included in version 3.4.0.

This command is not included in version 3.5.0.

This command is not included in version 3.6.0.

This command is not included in version 3.7.0.

This command is not included in version 3.7.1.

This command is not included in version 3.8.0.

This command is not included in version 3.9.0.

This command is not included in version 3.12.0.

This command is not included in version 3.13.0.

This command is not included in version 3.13.1.