コマンドラインインターフェイス (CLI) を使用したファイル転送 - Nimble Studio File Transfer
ファイルをアップロードするホットフォルダの設定ファイルのダウンロード

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

コマンドラインインターフェイス (CLI) を使用したファイル転送

以下のセクションでは、コマンドラインインターフェイス (CLI) を使用してホットフォルダをアップロード、ダウンロード、および設定する方法について詳しく説明します。File Transfer

ファイルをアップロードする

次のコマンドは、コマンドラインインターフェイス (CLI) 用です。これらのコマンドを使用すると、設定ファイルに設定した対応する S3 バケットからファイルをダウンロードできます。これらのコマンドは、コンピュータ上のどこからでも実行できます。ただし、これらのコマンドは root から実行することをお勧めします。

File Transfer は、指定されたフォルダ構造を保持します。つまり、ファイルが Amazon S3 に到達した後もフォルダ構造は変わりません。ただし、File Transfer に絶対パスを指定することはできません。つまり、ファイルパスを / (フォワードスラッシュ) で始めることはできません。

File Transfer は、すべての S3 ストレージクラスに対してアップロードします。ストレージクラスの詳細については、「Amazon S3 ストレージクラス」を参照してください。

注記

ローカルコンピュータでスリープモードを無効にすることをお勧めします。コンピュータでスリープモードを有効にすると、進行中の転送が中断される可能性があります。[設定] で、[スリープを無効にする (macOS のみ)] を切り替えます。

CLI を使用してアップロードを開始するには

  1. ターミナルを開きます。

  2. (推奨) アップロードしたいファイルとフォルダを含むフォルダに移動します。

  3. コンピュータの任意の場所から以下のコマンドを実行して、ローカルマシンから Amazon S3 にファイルをアップロードします。

    filetransfer upload [transfer profile] [relative path]

    1. [transfer profile] を、使用する転送プロファイルに置き換えます。

    2. [相対パス] を、アップロードしたいファイルまたはディレクトリのパスに置き換えます。

      1. 相対パスは、/ (フォワードスラッシュ) で始まりません。例: Users/username/Desktop/folder1

      2. 絶対パスは使用しないでください。絶対ファイルパスは、/ (フォワードスラッシュ) で始まります。例: /Users/username/Desktop/folder1

    3. コマンドの例: filetransfer upload [transfer profile name] /Users/username/Desktop/folder1

File Transfer は、ファイルで File Transfer チェックサム を実行します。チェックサムは、ファイルが予期せず変更されたかどうかを検出するための、追加のファイル整合性の検証に使用されます。これらのチェックサムが完了すると、転送が開始されます。独自のメディアハッシュリスト (MHL) を提供すると、File Transfer はファイルが MHL に定義されているチェックサムと一致することを確認できます。MHL は XML ファイルで、多くの場合、未加工のカメラ映像に含まれています。

Flags

特定のアクションを実行するために、コマンドの末尾にフラグを追加できます。フラグの使用は任意です。

フラグ 説明 例

--help

使用可能なフラグとコマンドの一覧を示します。

filetransfer --help

--checksum-algorithm

File Transfer がどのチェックサム計算を実行するかを定義します。サポートされる値: md5、XXHash、XXHash64、XXH3。

filetransfer upload [remote configuration] [relative path] –-checksum-algorithm xxhash64

--enable-metadata-filter

使用すると、File Transfer がシステムメタデータファイルを自動的にフィルタリングします。これらのファイルには、Thumbs.db、.DS_Store、._. で始まるファイルが含まれます。

filetransfer upload [remote configuration] [relative path] --enable-metadata-filter

--filter

転送されるファイルを、その形式に基づいてフィルタリングします。フィルタフィールドには有効な正規表現を使用できます。例: ^.*\.(mov)$ と指定すると、.mov で終わるファイルのみが転送されます。設定ファイルにフィルタを追加して、特定のアクションを実行することができます。フィルタを特定のコマンドでフラグとして使用する代わりに、フィルタを設定に追加すると、File Transfer によりすべての転送にそのアクションが適用されます。

filetransfer upload [remote configuration] [relative path] --filter "^.*\.(mov)$"

このコマンドは、.mov 形式のファイルのみをアップロードします。

--force

フィルタや競合に関係なく、強制的に転送します。デフォルトでは、File Transfer は以前に転送されたファイルを転送しません。

force フラグを使用すると、File Transfer がフィルタや競合を無視します。この機能は、ダウンロードする必要があるファイルを誤って削除してしまった場合に便利です。

filetransfer upload [remote configuration] [relative path] --force

--max-age

現在時刻に終了する時間枠内に作成または変更されたファイルのみを転送します。単位を指定しない場合、最大経過時間は秒単位になります。例えば、2d と指定すると過去 2 日間のファイルがダウンロードされ、3500 と指定すると過去 3500 秒間のファイルがアップロードされます。

filetransfer upload [remote configuration] [relative path] --max-age “2d”

上記のコマンドは、過去 2 日間のファイルのみを S3 バケットにアップロードします。

--retry-count

エラーが発生した場合、File Transfer は再試行数と同じ回数だけファイルの転送を試みます。

filetransfer upload [remote configuration] [relative path] --retry-count 4

--chunk-size

チャンクサイズ (MB 単位) (デフォルトは 25)

filetransfer upload [remote configuration] [relative path] --chunk-size 50

--auto-tuning

転送を最適化するための最適な設定値を決定することをツールに許可

filetransfer upload [remote configuration] [relative path] --auto-tuning true

--max-active-checksums

アクティブなチェックサムの最大数 (デフォルトは 1)。このフラグはアップロードにのみ有効です。

filetransfer upload [remote configuration] [relative path] --max-active-checksums 5

--max-active-transfers

転送の最大数

filetransfer upload [remote configuration] [relative path] --max-active-transfers 10

--prefix

アップロードとダウンロード用の S3 プレフィックスパス

filetransfer upload [remote configuration] [relative path] --prefix my/s3/path

--profile

AWS 名前付きプロフィール

filetransfer upload [remote configuration] [relative path] --profile my_named_profile

--threads

アップロード 1 回あたりのスレッド数 (デフォルトは 10)

filetransfer upload [remote configuration] [relative path] --threads 10

FILETRANSFER_CONFIG_DIR

デフォルトの .filetransfer フォルダを上書きします。

この変数では、設定ファイルとデータベースファイルを保存する任意のディレクトリを定義できます。FILETRANSFER_CONFIG_DIR が設定されていない場合は、デフォルト値の ~/.filetransfer が使用されます。ファイルには引き続き、configuration.yaml または configuration.yaml、および checksum-cache.db という名前を付ける必要があります。存在しない場合は作成されます。

FILETRANSFER_CONFIG_DIR=Desktop/config1 filetransfer upload [remote configuration] [relative path]

ホットフォルダの設定

CLI を使用してアップロードホットフォルダを設定するには

  1. コンピュータ上の任意のテキスト編集ソフトウェアで設定ファイルを開きます。

    1. Windows: コンピュータ上の User/<your username> フォルダに移動します。.filetransfer フォルダを開き、テキストエディタで filetransfer.yaml ファイルを開きます。

    2. macOS: Cmd+Shift+G と入力します。次に、~/.filetransfer と入力します。テキストエディタで filetransfer.yaml ファイルを開きます。

    3. Linux: 任意のテキストエディタを使用して filetransfer.yaml ファイルを開きます。このファイルは ~/.filetransfer/configuration.yaml にあります。

  2. 以下のフィールドを使用して新しい hot_folder セクションを作成します。

    hot folders:
              - enabled: true
              local_source_folder: /Users/user/myhotfolder
              name: my_hot_folder
              remote_configurations:
                - remote_configuration_name: example_configuration
                  s3_destination_folder: my/s3/prefix

  3. ホットフォルダは、enabled を true に設定した場合にのみ、アクティブになります。

  4. local_source_folder を、File Transfer でモニタリングするフォルダの場所に置き換えます。ファイルパスには、完全なパスが含まれている必要があります: C:\path\to\upload-hot-folder (Windows) または /path/to/upload-hot-folder (Linux と macOS)。

  5. remote_configurations で、次の操作を行います。

    1. remote_configuration_name を、使用するリモート設定の名前に置き換えます。リモート設定は protocols.s3.transfer_profiles で確認できます。

    2. (オプション) s3_destination_folder を、ファイルのアップロード先の S3 フォルダに置き換えます。Amazon S3 にフォルダがまだ存在していない場合は、File Transfer で作成します。値が設定されていない場合、ファイルはバケットのルートに配置されます。

    3. (オプション) ここにはリモート設定のエントリを必要な数だけ追加できます。ホットフォルダは各リモート設定を使用してアップロードを開始します。これにより、複数のバケットにアップロードする 1 つのホットフォルダを設定できます。

  6. 複数のホットフォルダを持つ 1 つのアップロードホットフォルダ設定の例を次に示します。この例には、2 つのホットフォルダがあります。

    1. 1 つ目のホットフォルダは、Media/drive フォルダを監視するように設定されています。このフォルダにファイルを追加すると、2 つのアップロードが開始されます。1 つは example1 リモート設定を使用し、もう 1 つは example2 リモート設定を使用します。各アップロードでは、それぞれの s3_destination_folder を使用します。

    2. 2 番目のホットフォルダは、/Users/user1/myhotfolder フォルダを監視するように設定されています。このフォルダにファイルを追加すると、another_configuration リモート設定を使用して 1 つのアップロードが開始されます。すべてのファイルは Amazon S3 の example_folder フォルダにアップロードされます。

    hot folders: 
        - enabled: true
          local_source_folder: /Media/drive
          name: my_hot_folder
          remote_configurations:
                - remote_configuration_name: example1
                  s3_destination_folder: my/s3/folder
                - remote_configuration_name: example2
                  s3_destination_folder: second/folder
        - enabled: true
          local_source_folder: /Users/user1/my_hot_folder
          name: another_hot_folder
          remote_configurations:
                - remote_configuration_name: another_configuration
                  s3_destination_folder: example/folder

  7. 設定ファイルを保存します。

    注記

    デーモンを起動するか、ホットフォルダを追加/更新すると、フォルダ全体の自動強制アップロードが開始されます。この動作を望まない場合は、GUI を開いてジョブをキャンセルできます。

ファイルのダウンロード

以下のコマンドで、設定ファイルでセットアップした対応する S3 バケットからファイルをダウンロードできます。これらのコマンドは、コンピュータ上のどこからでも実行できます。これらのコマンドは、ルートから実行することをお勧めします。

File Transfer では、Deep Archive または Glacier のストレージクラスから直接ダウンロードすることはできません。これは、これらが別のシステムに保存されているためです。これらの種類のオブジェクトでは、別の方法でファイルを取得する必要があります。さまざまなシステムからオブジェクトを取得する方法の詳細については、「アーカイブされたオブジェクトの復元」を参照してください。ストレージクラスの詳細については、「Amazon S3 ストレージクラス」を参照してください。

注記

ローカルコンピュータでスリープモードを無効にすることをお勧めします。コンピュータでスリープモードを有効にすると、進行中の転送が中断される可能性があります。[設定] で、[スリープを無効にする (macOS のみ)] を切り替えます。

CLI を使用してダウンロードを開始するには

  1. ターミナルを開きます。

  2. (推奨) ファイルをダウンロードするフォルダに移動します。

  3. コンピュータ上の任意の場所から以下のコマンドを実行して、Amazon S3 からコンピュータにファイルをダウンロードします。

    filetransfer download [transfer profile]
                  [relative path]

    1. [transfer profile] を、使用する転送プロファイルに置き換えます。

    2. [relative path] を、ファイルのダウンロード先のパスに置き換えます。

      1. 相対パスは、/ (フォワードスラッシュ) で始まりません。例: Users/username/Desktop/folder1

      2. 絶対パスは使用しないでください。絶対ファイルパスは、/ (フォワードスラッシュ) で始まります。例: /Users/username/Desktop/folder1

    3. コマンドの例: filetransfer download [transfer profile name] /Users/username/Desktop/folder1

File Transfer がローカルの File Transfer データベースをチェックして、選択したファイルが既にダウンロードされているかどうかを確認します。

Flags

コマンドの末尾にフラグを追加して、特定のアクションを実行できます。フラグの使用は任意です。

フラグ 説明 例

--help

使用可能なフラグとコマンドの一覧を示します。

filetransfer --help

--checksum-algorithm

File Transfer がどのチェックサム計算を実行するかを定義します。サポートされる値: md5、XXHash、XXHash64、XXH3。

filetransfer download [remote configuration] [relative path] –-checksum-algorithm xxhash64

--enable-metadata-filter

使用すると、File Transfer がシステムメタデータファイルを自動的にフィルタリングします。これらのファイルには、Thumbs.db、.DS_Store、._. で始まるファイルが含まれます。

filetransfer download [remote configuration] [relative path] --enable-metadata-filter

--filter

転送されるファイルを、その形式に基づいてフィルタリングします。フィルタフィールドには有効な正規表現を使用できます。例: ^.*\.(mov)$ と指定すると、.mov で終わるファイルのみが転送されます。設定ファイルにフィルタを追加して、特定のアクションを実行することができます。フィルタを特定のコマンドでフラグとして使用する代わりに、フィルタを設定に追加すると、File Transfer によりすべての転送にそのアクションが適用されます。

filetransfer download [remote configuration] [relative path] --filter "^.*\.(mov)$"

このコマンドは、.mov 形式のファイルのみをダウンロードします。

--force

フィルタや競合に関係なく、強制的に転送します。デフォルトでは、File Transfer は以前に転送されたファイルを転送しません。

force フラグを使用すると、File Transfer がフィルタや競合を無視します。この機能は、ダウンロードする必要があるファイルを誤って削除してしまった場合に便利です。

filetransfer download [remote configuration] [relative path] --force

--max-age

現在時刻に終了する時間枠内に作成または変更されたファイルのみを転送します。単位を指定しない場合、最大経過時間は秒単位になります。例えば、2d と指定すると過去 2 日間のファイルがダウンロードされ、3500 と指定すると過去 3500 秒間のファイルがアップロードされます。

filetransfer download [remote configuration] [relative path] --max-age “2d”

上記のコマンドは、過去 2 日間のファイルのみを S3 バケットにダウンロードします。

--retry-count

エラーが発生した場合、File Transfer は再試行数と同じ回数だけファイルの転送を試みます。

filetransfer download [remote configuration] [relative path] --retry-count 4

--chunk-size

チャンクサイズ (MB 単位) (デフォルトは 25)

filetransfer download [remote configuration] [relative path] --chunk-size 50

--auto-tuning

転送を最適化するための最適な設定値を決定することをツールに許可

filetransfer download [remote configuration] [relative path] --auto-tuning true

--max-active-checksums

アクティブなチェックサムの最大数 (デフォルトは 1)

filetransfer download [remote configuration] [relative path] --max-active-checksums 5

--max-active-transfers

転送の最大数

filetransfer download [remote configuration] [relative path] --max-active-transfers 10

--prefix

アップロードとダウンロード用の S3 プレフィックスパス

filetransfer download [remote configuration] [relative path] --prefix my/s3/path

--profile

AWS 名前付きプロファイル

filetransfer download [remote configuration] [relative path] --profile my_named_profile

--threads

ダウンロード 1 回あたりのスレッド数 (デフォルトは 10)

filetransfer download [remote configuration] [relative path] --threads 10

FILETRANSFER_CONFIG_DIR

デフォルトの .filetransfer フォルダを上書きします。

この変数では、設定ファイルとデータベースファイルを保存する任意のディレクトリを定義できます。FILETRANSFER_CONFIG_DIR が設定されていない場合は、デフォルト値の ~/.filetransfer が使用されます。ファイルには引き続き、configuration.yaml または configuration.yaml、および checksum-cache.db という名前を付ける必要があります。存在しない場合は作成されます。

FILETRANSFER_CONFIG_DIR=Desktop/config1 filetransfer download [remote configuration] [relative path]