はじめに

ptool は Lua スクリプトを実行し、実用的な自動化のための標準ライブラリを注入します。

現在の主なエントリーポイントは次のとおりです。

ptool run <file>

.lua ファイルでは、短縮形も使えます。

ptool <file.lua>

対話的に試したい場合、ptool には次のコマンドもあります。

ptool repl

スクリプトの実行時、ptool はグローバルテーブル ptool と短い別名 p を通じて API を公開します。

インストール

Linux と macOS では、リリース用インストーラーで ptool をインストールできます。

curl -fsSL https://peterlits.net/ptool/install.sh | bash

このインストーラーは現在のプラットフォーム向けの最新ビルド済みリリースをダウンロードし、ptool を ~/.local/bin/ptool にインストールし、必要に応じて PATH のヒントを表示します。

最新の安定版ではなく特定のリリースタグをインストールするには:

curl -fsSL https://peterlits.net/ptool/install.sh | bash -s -- v0.2.0

~/.local/bin ではなく独自のバイナリディレクトリにインストールするには:

curl -fsSL https://peterlits.net/ptool/install.sh | bash -s -- --bin-dir "$HOME/.cargo/bin"

ptool.use("v0.1.0")

ptool.run("echo", {"hello", "world"})

ptool.use(...) は、そのスクリプトが必要とする最小の ptool バージョンを宣言します。これにより期待する API バージョンを明示でき、古いランタイムでは早い段階で失敗します。詳しくはコア Lua API を参照してください。

実行方法:

ptool run script.lua
ptool script.lua

スクリプトのパスの後ろに追加の CLI 引数を渡せます。

ptool run script.lua --name alice -v a.txt b.txt
ptool script.lua --name alice -v a.txt b.txt

これらはスクリプト内で ptool.args.parse(...) を使って解析できます。

ptool は shebang ファイルをサポートしています。.lua 向けの短縮形を使うと、スクリプトは次のように始められます。

#!/usr/bin/env ptool

これにより、実行権限ビットを付けたあとでスクリプトを直接実行できます。