tw
コマンドラインの Seqera Platform です。パイプライン、アクション、コンピューティング環境などの Seqera の概念をターミナルにもたらします。
Seqera Platform は、データ パイプラインとコンピューティング リソースを管理するためのフルスタック アプリケーションです。これにより、オンプレミスまたは任意のクラウドで大規模な共同データ分析が可能になります。
CLI は Seqera と対話して、パイプラインの起動、クラウド リソースの管理、分析の管理を行うためのインターフェイスを提供します。
主な機能は次のとおりです。
Nextflow のようなエクスペリエンス: tw CLI は開発者に優しい環境を提供します。パイプラインは Nextflow と同様に CLI を使用して起動できますが、監視、ロギング、リソース プロビジョニング、データセット管理、および共同共有という Seqera の利点が得られます。
Infrastructure as Code : パイプラインやコンピューティング環境を含むすべての Seqera リソースは、宣言的な方法で記述できます。これにより、バージョン管理してコードとして扱うことができる分析環境の完全な定義が可能になります。これにより、構成の共有と日常的な管理が大幅に簡素化されます。
OpenAPI 上に構築: tw CLI は、OpenAPI 3.0 仕様を使用する Seqera Platform API を介して Seqera と対話します。 CLI は Seqera アプリケーションを完全に制御できるため、ユーザーはパイプラインの送信と実行環境について最大限の洞察を得ることができます。
アプリケーションの詳細については、Seqera Platform のドキュメントを参照してください。
2 つの CLI は、macOS、Windows、および Linux にインストールできます。
Seqera Cloud および Enterprise バージョン 21.08 以降と互換性があります。
このガイドでは、CLI のインストールと設定、クラウドインフラストラクチャのプロビジョニング、AWS Batch コンピューティング環境へのパイプラインの起動について説明します。
リリース ページのアセットから OS の最新バージョンをダウンロードします。
ファイルの名前を変更して実行可能にします。
mv tw- * tw
chmod +x ./tw
$PATH
変数にアクセスできるディレクトリにファイルを移動します。
sudo mv tw /usr/local/bin/
CLI が Seqera インスタンスと対話するには、アクセス トークンが必要です。 Seqera UI のユーザー メニューから[ユーザー トークン]を選択し、 [トークンの追加]を選択して新しいトークンを作成します。
アクセス トークン値をコピーし、次の 2 つの方法のいずれかで CLI で使用します。
環境変数:
トークンをシェル変数としてターミナルに直接エクスポートします。
export TOWER_ACCESS_TOKEN= < your access token >
環境に永続的に追加するには、 export
コマンドを.bashrc
、 .zshrc
、または.bash_profile
ファイルに追加します。
2つのコマンドフラグ:
--access-token
を使用してtw
コマンドにアクセス トークンを直接指定します。
tw --access-token= < your access token > < other options >
必要に応じて、上記と同じ方法を使用して、次の必須ではない環境変数を構成します。
TOWER_WORKSPACE_ID
: ワークスペースID。デフォルト: ユーザーのワークスペース。TOWER_API_ENDPOINT
: Seqera API URL。デフォルト: api.cloud.seqera.io
。
TOWER_WORKSPACE_ID
、組織ページの[ワークスペース]タブから確認できます。あるいは、トークンがアクセスできるすべてのワークスペースをtw workspaces list
でリストし、コマンド出力からワークスペース ID をコピーすることもできます。
インストール、構成、接続を確認します。
$ tw info
System health status
---------------------------------------+------------------
Remote API server connection check | OK
Tower API version check | OK
Authentication API credential's token | OK
tw
CLI コマンドCLI の使用方法の詳細については、「使用法」を参照してください。
次のコマンドを使用して、現在のセッションでオートコンプリートをアクティブにします。
source <( tw generate-completion )
デフォルトの Java 認証局で認識されないプライベート CA SSL 証明書を使用している場合は、カスタムcacerts
ストアを使用します。
tw -Djavax.net.ssl.trustStore=/absolute/path/to/cacerts info
バイナリの名前をtw-binary
に変更し、すべてのセッションにカスタムcacerts
ストアを自動的に含めるtw
スクリプトを作成できます。
#! /usr/bin/env bash
tw-binary -Djavax.net.ssl.trustStore=/absolute/path/to/cacerts $@
tw CLI は、Java GraalVM からのネイティブ コンパイルによって作成されたプラットフォーム バイナリ実行可能ファイルです。バイナリの開発バージョンをコンパイルしてビルドするには、次の手順を実行します。
必要に応じて SDKMan をインストールしてください。
tower-cli プロジェクトのルートから、GraalVM をインストールします。
sdk env install
これにより、SDKMan は tower-cli プロジェクト固有の.sdkmanrc
構成を使用するようになります。
native-image
をインストールします。
gu install native-image
Github 認証情報をエクスポートします。 Github ではパブリック パッケージの認証が必要です (トークンにはread:packages
スコープのみが必要です)。
export GITHUB_USERNAME=...
export GITHUB_TOKEN=...
ネイティブ クライアントを作成します。
./gradlew nativeCompile
これにより、 tw
のローカルでコンパイルされたバージョンが、nativeCompile ディレクトリにインストールされます。
Produced artifacts:
<tower-cli-repository-root>/build/native/nativeCompile/tw (executable)
========================================================================================================================
Finished generating 'tw' in 1m 6s.
[native-image-plugin] Native Image written to: <tower-cli-repository-root>/build/native/nativeCompile
BUILD SUCCESSFUL in 1m 8s
6 actionable tasks: 2 executed, 4 up-to-date
tw
実行します:
./build/native/nativeCompile/tw
このリポジトリのルートで./tw
スクリプトを実行して、非バイナリ開発バージョンを実行します。
アパッチ2.0