watermint toolbox - The multi-purpose utility command-line tool for web services

dev release publish

リリースを公開します

セキュリティ

watermint toolboxは認証情報をファイルシステム上に保存します. それは次のパスです:

OS パス
Windows %HOMEPATH%\.toolbox\secrets (e.g. C:\Users\bob.toolbox\secrets)
macOS $HOME/.toolbox/secrets (e.g. /Users/bob/.toolbox/secrets)
Linux $HOME/.toolbox/secrets (e.g. /home/bob/.toolbox/secrets)

これらの認証情報ファイルはDropboxサポートを含め誰にも共有しないでください. 不必要になった場合にはこれらのファイルを削除しても問題ありません. 認証情報の削除を確実にしたい場合には、アプリケーションアクセス設定または管理コンソールからアプリケーションへの許可を取り消してください.

方法は次のヘルプセンター記事をご参照ください:

  • GitHub: https://developer.github.com/apps/managing-oauth-apps/deleting-an-oauth-app/

認可スコープ

説明
GitHub: プライベートリポジトリを含む、リポジトリへのフルアクセスを許可それには、コードへの読み書き可能なアクセス、コミットステータス、リポジトリや組織のプロジェクト、招待状、共同作業者、チームメンバーの追加、デプロイメントステータス、リポジトリや組織のWebhookなどが含まれます. また、ユーザーのプロジェクトを管理する機能も付与されています.

認可

最初の実行では、tbxはあなたのGitHubアカウントへの認可を要求します. Enterキーを押すと、ブラウザが起動します。その後、サービスが認証を行い、tbxがその結果を受け取ります。認証成功のメッセージが表示されたら、ブラウザのウィンドウを閉じてもかまいません。


watermint toolbox xx.x.xxx
==========================

© 2016-2025 Takayuki Okazaki
オープンソースライセンスのもと配布されています. 詳細は`license`コマンドでご覧ください.

このプロジェクトは積極的にメンテナンスされていません。詳細については、https://github.com/watermint/toolbox/discussions/911 をご覧ください。

認可URLを開きます:
https://github.com/login/oauth/authorize?client_id=xxxxxxxxxxxxxxxxxxxx&redirect_uri=http%3A%2F%2Flocalhost%3A7800%2Fconnect%2Fauth&response_type=code&scope=repo&state=xxxxxxxx

インストール

最新リリースからコンパイル済みのバイナリをダウンロードしてください. Windowsをお使いの方は、tbx-xx.x.xxx-win.zipのようなzipファイルをダウンロードしてください. その後、アーカイブを解凍し、デスクトップ フォルダに tbx.exe を配置します. watermint toolboxは、システムで許可されていれば、システム内のどのパスからでも実行できます. しかし、説明書のサンプルでは、デスクトップ フォルダを使用しています. デスクトップ フォルダ以外にバイナリを配置した場合は、パスを読み替えてください.

利用方法

このドキュメントは”デスクトップ”フォルダを例として使用します.

実行

Windows:

cd $HOME\Desktop
.\tbx.exe dev release publish -artifact-path /LOCAL/PATH/TO/ARTIFACT

macOS, Linux:

$HOME/Desktop/tbx dev release publish -artifact-path /LOCAL/PATH/TO/ARTIFACT

macOS Catalina 10.15以上の場合: macOSは開発者情報を検証します. 現在、tbxはそれに対応していません. 実行時の最初に表示されるダイアログではキャンセルします. 続いて、”システム環境設定”のセキュリティーとプライバシーから一般タブを選択します. 次のようなメッセージが表示されています:

“tbx”は開発元を確認できないため、使用がブロックされました。

“このまま開く”というボタンがあります. リスクを確認の上、開いてください. ２回目の実行ではダイアログに”開く”ボタンがありますので、これを選択します

オプション:

-artifact-path
成果物へのパス
-branch
対象ブランチ. Default: main
-conn-github
アカウントの別名. Default: default
-executable-name
公開する実行可能ファイルの名前. Default: tbx
-homebrew-repo-branch
公開に使用する Homebrew tap リポジトリのブランチです。. Default: master
-homebrew-repo-name
Homebrew tap リポジトリの名前. Default: homebrew-toolbox
-homebrew-repo-owner
Homebrew tap リポジトリのオーナー. Default: watermint
-repo-name
リリースを公開するリポジトリの名前です。. Default: toolbox
-repo-owner
リリースを公開するリポジトリの所有者です。. Default: watermint
-skip-tests
エンドツーエンドテストをスキップします.. Default: false

共通のオプション:

-auth-database
認証データベースへのカスタムパス (デフォルト: $HOME/.toolbox/secrets/secrets.db)
-auto-open
成果物フォルダまたはURLを自動で開く. Default: false
-bandwidth-kb
コンテンツをアップロードまたはダウンロードする際の帯域幅制限(Kバイト毎秒). 0の場合、制限を行わない. Default: 0
-budget-memory
メモリの割り当て目標 (メモリ使用量を減らすために幾つかの機能が制限されます). Options: low, normal. Default: normal
-budget-storage
ストレージの利用目標 (ストレージ利用を減らすためログ、機能を限定します). Options: low, normal, unlimited. Default: normal
-concurrency
指定した並列度で並列処理を行います. Default: プロセッサー数
-debug
デバッグモードを有効にする. Default: false
-experiment
実験的機能を有効化する
-extra
追加パラメータファイルのパス
-lang
表示言語. Options: auto, en, ja. Default: auto
-output
出力書式 (none/text/markdown/json). Options: text, markdown, json, none. Default: text
-output-filter
出力フィルタ・クエリ（jq構文）。レポートの出力はjq構文を使ってフィルタリングされる。このオプションは、レポートがJSONとして出力される場合にのみ適用される。
-proxy
HTTP/HTTPS プロクシ (hostname:port). プロキシの設定を省略したい場合はDIRECTを指定してください
-quiet
エラー以外のメッセージを抑制し、出力をJSONLフォーマットに変更します. Default: false
-retain-job-data
ジョブデータ保持ポリシー. Options: default, on_error, none. Default: default
-secure
トークンをファイルに保存しません. Default: false
-skip-logging
ローカルストレージへのログ保存をスキップ. Default: false
-verbose
現在の操作を詳細に表示します.. Default: false
-workspace
ワークスペースへのパス

実行結果

作成されたレポートファイルのパスはコマンド実行時の最後に表示されます. もしコマンドライン出力を失ってしまった場合には次のパスを確認してください. [job-id]は実行の日時となります. このなかの最新のjob-idを各委任してください.

OS パスのパターン 例
Windows %HOMEPATH%\.toolbox\jobs\[job-id]\reports C:\Users\bob.toolbox\jobs\20190909-115959.597\reports
macOS $HOME/.toolbox/jobs/[job-id]/reports /Users/bob/.toolbox/jobs/20190909-115959.597/reports
Linux $HOME/.toolbox/jobs/[job-id]/reports /home/bob/.toolbox/jobs/20190909-115959.597/reports

レポート: commit

コミット情報 このコマンドはレポートを3種類の書式で出力します. commit.csv, commit.json, ならびに commit.xlsx.

列 説明
sha コミットのSHA1
url コミットのURL

-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます

レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; commit_0000.xlsx, commit_0001.xlsx, commit_0002.xlsx, …

レポート: content

コンテンツのメタデータ このコマンドはレポートを3種類の書式で出力します. content.csv, content.json, ならびに content.xlsx.

列 説明
type コンテンツ種別
name 名称
path パス
sha SHA1
size サイズ
target シンボリックリンクの宛先

-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます

レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; content_0000.xlsx, content_0001.xlsx, content_0002.xlsx, …

レポート: result

レシピテスト結果 このコマンドはレポートを3種類の書式で出力します. result.csv, result.json, ならびに result.xlsx.

列 説明
path レシピへのパス
name レシピの名称
skip テストがスキップされた場合はTrue
timeout_enabled タイムアウトモードが有効な場合はTrue
use_mock モックモードを有効にしている場合はTrue
timeout テストタイムアウトの場合はTrue
duration テスト時間(ミリ秒)
no_error エラーを受信しなかった場合はTrue
error エラー

-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます

レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; result_0000.xlsx, result_0001.xlsx, result_0002.xlsx, …

© 2016-2025 Takayuki Okazaki
}