yml

yml は設定向けのコンパクトな YAML サブセットを扱います。入れ子のマッピング、スカラー値、単純なリストをドット区切りパスで読み取り、検索、変更できます。

データバージョン 1.1.6安定版
lil-terminal

概要

yml は一般的な YAML 設定をファイル上で直接扱う小さな操作系です。ドットパス、検索、1値の変更・削除、対応サブセットの検証、dump による全ソース確認をまとめます。

インデントをドット区切りパスとして扱う

パーサーは意図的に厳格です。タブと - item 形式のブロックリストは非対応です。見慣れない YAML はまず -c で検証し、複雑な文書には edit または code を使います。

構文

lil-terminal
yml <file> [key|options] · yml dump <file>

リファレンス

yml <file> [key|options] | yml dump <file>

Read and update the supported subset of YAML settings, with clear safeguards for unsupported constructs.

コマンド一覧

yml <file> [key|options] | yml dump <file>

yml <file>

YAML データを表示する

yml <file> <key>

ドット区切りの完全一致パスを表示する

yml dump <file>

正規化した YAML ソースを表示する

-f <text|mask> [-k|-v]

キーまたは値を検索する。* と ? を含む場合はマスクとして扱う

-w <key> : <value>

値をファイルへ直接書き込む

-w <key> < <file>

別ファイルから読み取った値を書き込む

-d <key>

ドット区切りパスの値を削除する

-c

YAML ファイルを検証する

設定の確認・検索・変更

まず yml config/app.yml で設定の一覧を表示し、database.host で値を確認します。-f はキーと値、-k はキーのみ、-v は値のみを検索します。通常の文字列は大文字小文字を区別せず、* と ? はワイルドカードです。-c は構文の検査、dump は再生成したテキストの表示です。

-w <key> : <value> はすぐに保存し、-w <key> < <file> は別ファイルから値を読み込み、-d <key> は指定したパスを削除します。数値や true/false は型付きの値として解釈される場合があります。更新前にバックアップを作成してください。$ は Core で最後に開いたファイルを指し、ファイル名だけでも登録済みの処理を呼び出せます。

対応範囲と安全な編集

インデント付きのマップと JSON 形式のインライン配列に対応しますが、- item 形式のリスト、タブ、アンカー、エイリアス、タグ、複数行ブロックには非対応です。重複キーは拒否されます。書き込み時にコメントや元の空白が失われます。複雑な YAML は edit または code で編集してください。Minimum はファイル全体の表示のみです。

インタラクティブな sandbox プレビュー

用意された例をページ上でそのまま実行できます。結果は事前に生成されてブラウザに表示され、サーバーではターミナルコマンドを実行しません。

ファイルを開いて $ で再利用する

インストールと管理

現在の互換バージョンをインストールします。全機能は Base、縮小版は Minimum を選び、すでに導入済みのモジュール更新には upgrade を使います。

Base と Minimum は同じ現在のモジュールリリースの二つのパッケージです。

Base パッケージ

ローカル参照と公開済みの全モードを含む完全パッケージをインストールします。

install yml
Minimum パッケージ

縮小パッケージをインストールします。ローカルリファレンスは含まれず、help <cmd> -i で現在のサーバーリファレンスを開きます。

install yml -m
正確な公開版

この公開済みバージョンを正確に指定してインストールします。

install yml -v 1.1.6
確認または更新

upgrade が互換性を確認し、必要な場合だけブロックを置換します。

upgrade yml
モジュールを削除

コアや他のモジュールに触れず拡張ブロックを削除します。

install yml -u

例

例はコピーできますが、サイトは実行しません。実プロジェクトではパス、権限、破壊的オプションを確認してください。

ファイルを開いて $ で再利用する
cd \sandbox\config | yml app.yml
application.name    lil-shop
application.debug   true
database.host       localhost
database.port       3306
database.options.0  utf8mb4
database.options.1  strict
YAML データを表示する
yml config/app.yml
application.name    lil-shop
application.debug   true
database.host       localhost
database.port       3306
database.options.0  utf8mb4
database.options.1  strict
ドット区切りの完全一致パスを表示する
yml config/app.yml database.host
localhost
ドット区切りの完全一致パスを表示する
yml config/app.yml database.options.1
strict
キーまたは値を検索する。* と ? を含む場合はマスクとして扱う
yml config/app.yml -f "database.*" -k
database.host       localhost
database.port       3306
database.options.0  utf8mb4
database.options.1  strict
キーまたは値を検索する。* と ? を含む場合はマスクとして扱う
yml config/app.yml -f "strict" -v
database.options.1  strict
キーまたは値を検索する。* と ? を含む場合はマスクとして扱う
yml config/app.yml -f "debug"
application.debug  true
値をファイルへ直接書き込む
yml config/app.yml -w application.debug : false
application.debug  false
別ファイルから読み取った値を書き込む
yml config/app.yml -w application.name < config/plain-value.txt
application.name  demo-site
存在しないファイルを扱う
yml config/app.yml -d database.options.0
application.name    lil-shop
application.debug   true
database.host       localhost
database.port       3306
database.options.0  strict
YAML ファイルを検証する
yml config/app.yml -c
Valid YAML
正規化した YAML ソースを表示する
yml dump config/app.yml
application:
  name: lil-shop
  debug: true
database:
  host: localhost
  port: 3306
  options: ["utf8mb4","strict"]
ドット区切りの完全一致パスを表示する
yml config/app.yml unknown.key
Path not found
YAML ファイルを検証する
yml config/invalid.yml -c
YAML block lists are not supported; use inline JSON-style lists
YAML データを表示する
yml config/missing.yml
File not found
値をファイルへ直接書き込む
yml config/app.yml -w database.port
Value required after : or 

この例で使うファイル: sandbox/config/app.yml

例では、保護されたドキュメント用 /sandbox/ ワークスペースのファイルまたはディレクトリを使います。

application:
  name: lil-shop
  debug: true
database:
  host: localhost
  port: 3306
  options: ["utf8mb4", "strict"]

関連ドキュメント

現在の公開版

v1.1.62026-11-01

プロダクション向け調整

yml の現在の安定版。yml は設定向けのコンパクトな YAML サブセットを扱います。