Skip to content

README.ja.md

Latest commit

 

History

History
199 lines (140 loc) · 8.09 KB

README.ja.md

File metadata and controls

199 lines (140 loc) · 8.09 KB
Raw

runex

English | 日本語

その一打を、術式へ昇華せよ。

runex は、短いトークンをリアルタイムに完全なコマンドへ展開する、クロスシェル対応の略語エンジンです。

どこから読むか

目的 読む場所
インストールしてとりあえず試す この README → Install → Setup
やりたいシナリオ用の config を探す docs/recipes.ja.md
フィールドの正確な意味を確認する docs/config-reference.md (英語)
設定したのに動かない時の切り分け docs/setup.ja.md#トラブルシューティング

特性

  • クロスシェル対応（bash / zsh / pwsh / cmd / nushell）
  • リアルタイム展開（トリガキー変更可能）
  • 設定ファイル1つで全シェルを管理
  • 条件付きルール（when_command_exists） — 指定したコマンドが現在のシェルで解決できる場合のみ展開
  • 高速・軽量（Rust コア）

概念

runex は短い入力を ルーン（rune） として受け取り、完全な キャスト（cast） に展開します。

gcm␣ → git commit -m
ls␣  → lsd

5 分で最初の展開

cargo install runex                # 1. インストール
runex init                         # 2. 設定作成 + シェル連携を追加
                                   #    (rcfile への書き込み前に確認プロンプト)
exec $SHELL                        # 3. 統合を読み込むため新しいシェルへ
gst<Space>                         # 4. → git status に展開される

runex init が生成するデフォルト設定には gst → git status のサンプ ルが入っているので、インストール直後に展開動作を確認できます。あとは 自分用の略語に書き換えていくだけ — コピペ可能なパターンは docs/recipes.ja.md にまとめてあります。

インストール

cargo install runex                       # Rust ツールチェーン
brew install shortarrow/runex/runex       # macOS / Linux
paru -S runex-bin                         # Arch Linux (AUR)
winget install ShortArrow.runex           # Windows

mise・ビルド済みバイナリ・プラットフォーム別の注意事項など、その他の経路は docs/install.ja.md を参照してください。

セットアップ

runex init は append-only で、書き込み前に必ず確認 します — 既存 の rcfile は末尾に 1 ブロック追加される以外、一切変更されません。 runex init が何をする / しないか で完全な保証を確認できます。

設定ファイルを作成し、rc ファイルにシェル連携行を追記します。各ステップで確認プロンプトが出ます:

$ runex init
Create config at ~/.config/runex/config.toml? [y/N] y
Created: ~/.config/runex/config.toml
Append shell integration to ~/.bashrc? [y/N] y
Appended integration to ~/.bashrc

-y を付けると確認をすべてスキップします。シェル別の手動設定 (bash / zsh / pwsh / nu / clink) は docs/setup.ja.md を参照してください。

設定

デフォルトパス: $XDG_CONFIG_HOME/runex/config.toml（未設定なら ~/.config/runex/config.toml、全プラットフォーム共通）。

環境変数 RUNEX_CONFIG または --config フラグで上書きできます。

keybind を設定するまでは、どのキーにも何も割り当てられません。

version = 1

[keybind.trigger]
default = "space"

[[abbr]]
key    = "ls"
expand = "lsd"
when_command_exists = ["lsd"]

[[abbr]]
key    = "gcm"
expand = "git commit -m"

[[abbr]]
key    = "gcam"
expand = "git commit -am '{}'"   # {} = 展開後ここにカーソルが残る

全フィールド・評価順・フォールバックチェーンの詳細は docs/config-reference.md を参照してください。コピペで使えるシナリオ別サンプル (Git ショートカット、シェル別コマンド、フォールバックチェーンなど) は docs/recipes.ja.md にまとめています。

コマンド

日常的に使うのは次の 5 つです:

runex init                       設定 + シェル連携をセットアップ (各書き込み前に確認)
runex doctor                     全体の健康診断
runex add <key> <expand>         略語ルールを設定ファイルに追加
runex which <token> --why        トークンが展開されるか・理由は何かを説明
runex export <shell>             シェル連携スクリプトを出力 (init 経由で source される)

CLI 全体のリファレンスは runex --help (または runex <subcommand> --help)。グローバルフラグ --config, --path-prepend, --json は意 味のある全サブコマンドで動きます。--json 対応は list, doctor, version, expand, which, timings, config where。

runex doctor は設定検証と並んで環境レベルのチェックも表示します。 effective_search_path (Windows 専用の PATH 補強概要) と integration:<shell> (rcfile マーカーの有無、clink lua のドリフト検知) の各行の意味は docs/config-reference.md で詳述されており、出力例は docs/setup.ja.md にあります。

展開を回避したいとき

trigger = "space" を使う場合：

  • bash では先頭に \ を付ける（例: \ls）か、command ls を使います。
  • PowerShell では \ls は別トークンになるだけです。標準 alias をそのまま使いたいなら Get-ChildItem のように完全なコマンド名を書いてください。

self_insert でキーを「展開せずにスペース挿入」にバインドすることもできます：

[keybind.trigger]
default = "space"

[keybind.self_insert]
default = "shift-space"   # pwsh/nu: Shift+Space は展開せずにスペースを挿入
# default = "alt-space"   # bash/zsh を含む全シェル対応
値 bash zsh pwsh nu
"alt-space" yes yes yes yes
"shift-space" no no yes yes

alias との差異

機能 alias runex
クロスシェル No Yes
リアルタイム展開 No Yes
条件付きルール No Yes

哲学

  • 1つの設定、全てのシェル
  • 最小の入力、最大の威力
  • 履歴検索より即応の展開

ロードマップ

直近:

  • doctor / init のエッジケース対応と診断改善

後回し:

  • ファジーマッチングフォールバック
  • インタラクティブピッカー
  • エディタ連携
  • 配布チャネル拡充（GitHub Releases、cargo-binstall、winget、mise github:）

名の由来

  • run + ex = expand / execute / express / extract / explode
  • rune x（7z の "x" で展開するように）
  • rune +x（chmod の "+x" で実行可能にするように）

謝辞

runex は fish shell の略語システム と zsh-abbr に着想を得ています。リアルタイムなトークン展開というアイデアはそこから生まれました — runex はそれを単一の設定ファイルであらゆるシェルに持ち込みます。

ライセンス

MIT または Apache-2.0 のいずれかを選択可能（デュアルライセンス）。明示的に別途合意がない限り、本プロジェクトへのあらゆる貢献も同様のデュアルライセンスで提供されるものとします。

サードパーティライセンスは THIRD_PARTY_LICENSES.md に記載しています。