ドキュメントを生成
最新リリースからコンパイル済みのバイナリをダウンロードしてください. Windowsをお使いの方は、tbx-xx.x.xxx-win.zipのようなzipファイルをダウンロードしてください. その後、アーカイブを解凍し、デスクトップ フォルダに tbx.exe を配置します.
watermint toolboxは、システムで許可されていれば、システム内のどのパスからでも実行できます. しかし、説明書のサンプルでは、デスクトップ フォルダを使用しています. デスクトップ フォルダ以外にバイナリを配置した場合は、パスを読み替えてください.
このドキュメントは”デスクトップ”フォルダを例として使用します.
Windows:
cd $HOME\Desktop
.\tbx.exe dev build doc
macOS, Linux:
$HOME/Desktop/tbx dev build doc
macOS Catalina 10.15以上の場合: macOSは開発者情報を検証します. 現在、tbxはそれに対応していません. 実行時の最初に表示されるダイアログではキャンセルします. 続いて、”システム環境設定”のセキュリティーとプライバシーから一般タブを選択します.
次のようなメッセージが表示されています:
“tbx”は開発元を確認できないため、使用がブロックされました。
“このまま開く”というボタンがあります. リスクを確認の上、開いてください. ２回目の実行ではダイアログに”開く”ボタンがありますので、これを選択します
| オプション | 説明 | デフォルト |
|---|---|---|
-badge |
ビルド状態のバッジを含める | true |
-doc-lang |
言語 |
| オプション | 説明 | デフォルト |
|---|---|---|
-auth-database |
認証データベースへのカスタムパス (デフォルト: $HOME/.toolbox/secrets/secrets.db) | |
-auto-open |
成果物フォルダまたはURLを自動で開く | false |
-bandwidth-kb |
コンテンツをアップロードまたはダウンロードする際の帯域幅制限(Kバイト毎秒). 0の場合、制限を行わない | 0 |
-budget-memory |
メモリの割り当て目標 (メモリ使用量を減らすために幾つかの機能が制限されます) | normal |
-budget-storage |
ストレージの利用目標 (ストレージ利用を減らすためログ、機能を限定します) | normal |
-concurrency |
指定した並列度で並列処理を行います | プロセッサー数 |
-debug |
デバッグモードを有効にする | false |
-experiment |
実験的機能を有効化する | |
-extra |
追加パラメータファイルのパス | |
-lang |
表示言語 | auto |
-output |
出力書式 (none/text/markdown/json) | text |
-output-filter |
出力フィルタ・クエリ（jq構文）。レポートの出力はjq構文を使ってフィルタリングされる。このオプションは、レポートがJSONとして出力される場合にのみ適用される。 | |
-proxy |
HTTP/HTTPS プロクシ (hostname:port). プロキシの設定を省略したい場合はDIRECTを指定してください |
|
-quiet |
エラー以外のメッセージを抑制し、出力をJSONLフォーマットに変更します | false |
-retain-job-data |
ジョブデータ保持ポリシー | default |
-secure |
トークンをファイルに保存しません | false |
-skip-logging |
ローカルストレージへのログ保存をスキップ | false |
-verbose |
現在の操作を詳細に表示します. | false |
-workspace |
ワークスペースへのパス |
プログラムはシステム設定から自動的にプロクシ設定情報を取得します. しかしながら、それでもエラーが発生する場合には明示的にプロクシを指定することができます. -proxy オプションを利用します, -proxy ホスト名:ポート番号のように指定してください. なお、現在のところ認証が必要なプロクシには対応していません.