gum

ガム

魅力的なシェルスクリプトのためのツール。 Go コードを書かなくても、スクリプトやエイリアスで Bubbles と Lip Gloss の力を活用できます。

上記の例は、単一のシェル スクリプト (ソース) から実行されています。

チュートリアル

Gum は、わずか数行のコードで便利なシェル スクリプトやドットファイル エイリアスを作成できる、高度に構成可能ですぐに使用できるユーティリティを提供します。ドットファイルの従来のコミットを作成するのに役立つ簡単なスクリプトを構築してみましょう。

ガムを使用してコミット タイプを尋ね、次を選択します。

gum choose " fix " " feat " " docs " " style " " refactor " " test " " chore " " revert " 

注記

このコマンド自体は stdout に出力されますが、あまり役に立ちません。後でコマンドを使用するために、標準出力を$VARIABLEまたはfile.txtに保存できます。

これらの変更の範囲を尋ねるプロンプトが表示されます。

gum input --placeholder " scope "

変更の概要と説明を求めるプロンプトが表示されます。

gum input --value " $TYPE$SCOPE : " --placeholder " Summary of this change "
gum write --placeholder " Details of this change "

コミットする前に確認してください:

gum confirm " Commit changes? " && git commit -m " $SUMMARY " -m " $DESCRIPTION "

これらのコマンドを 1 つのスクリプトに組み合わせる完全な例を確認してください。

インストール

パッケージマネージャーを使用します。

 # macOS or Linux
brew install gum

# Arch Linux (btw)
pacman -S gum

# Nix
nix-env -iA nixpkgs.gum

# Flox
flox install gum

# Windows (via WinGet or Scoop)
winget install charmbracelet.gum
scoop install charm-gum

Debian/Ubuntu

sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
echo " deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * * " | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install gum

Fedora/RHEL/OpenSuse

 echo ' [charm]
name=Charm
baseurl=https://repo.charm.sh/yum/
enabled=1
gpgcheck=1
gpgkey=https://repo.charm.sh/yum/gpg.key ' | sudo tee /etc/yum.repos.d/charm.repo
sudo rpm --import https://repo.charm.sh/yum/gpg.key

# yum
sudo yum install gum

# zypper
sudo zypper refresh
sudo zypper install gum

またはダウンロードしてください:

• パッケージは Debian、RPM、Alpine 形式で利用できます
• バイナリは、Linux、macOS、Windows、FreeBSD、OpenBSD、および NetBSD で利用できます。

または、 goでインストールするだけです。

go install github.com/charmbracelet/gum@latest

コマンド

• choose : 選択肢のリストからオプションを選択します
• confirm : ユーザーにアクションの確認を求めます
• file : フォルダーからファイルを選択します
• filter : リストから項目をフィルターします
• format : テンプレートを使用して文字列をフォーマットします
• input : 入力を求めるプロンプト
• join : テキストを垂直または水平に結合します
• pager : ファイルをスクロールします
• spin : コマンドの実行中にスピナーを表示します。
• style : テキストに色、境界線、間隔を適用します。
• table : データのテーブルをレンダリングします
• write : 長文テキストの入力を求めるプロンプト
• log : 出力するログメッセージ

カスタマイズ

--flagsと$ENVIRONMENT_VARIABLESを使用してgumオプションとスタイルをカスタマイズできます。各コマンドのカスタマイズおよび構成オプションの詳細については、 gum <command> --help参照してください。

--flagsを使用してカスタマイズします。

gum input --cursor.foreground " #FF0 " 
          --prompt.foreground " #0FF " 
          --placeholder " What's up? " 
          --prompt " * " 
          --width 80 
          --value " Not much, hby? "

ENVIRONMENT_VARIABLESを使用してカスタマイズします。

 export GUM_INPUT_CURSOR_FOREGROUND= " #FF0 "
export GUM_INPUT_PROMPT_FOREGROUND= " #0FF "
export GUM_INPUT_PLACEHOLDER= " What's up? "
export GUM_INPUT_PROMPT= " * "
export GUM_INPUT_WIDTH=80

# --flags can override values set with environment
gum input

入力

簡単なコマンドで入力を求めます。

gum input > answer.txt
gum input --password > password.txt

書く

複数行のテキストの入力を求めるプロンプトが表示されます (テキストの入力を完了するにはctrl+d )。

gum write > story.txt

フィルター

あいまい一致を使用して値のリストをフィルター処理します。

 echo Strawberry >> flavors.txt
echo Banana >> flavors.txt
echo Cherry >> flavors.txt
gum filter < flavors.txt > selection.txt

--limitフラグまたは--no-limitフラグを使用して複数のオプションを選択します。 tabまたはctrl+space使用して選択し、 enterて確認します。

cat flavors.txt | gum filter --limit 2
cat flavors.txt | gum filter --no-limit

選ぶ

選択肢のリストからオプションを選択します。

 echo " Pick a card, any card... "
CARD= $( gum choose --height 15 {{A,K,Q,J},{10..2}} " " {♠,♥,♣,♦} )
echo " Was your card the $CARD ? "

--limitまたは--no-limitフラグを使用して複数の項目を選択することもできます。これにより、選択できる項目の最大数が決まります。

cat songs.txt | gum choose --limit 5
cat foods.txt | gum choose --no-limit --header " Grocery Shopping " 

確認する

アクションを実行するかどうかを確認します。選択に応じてコード0 (肯定) または1 (否定) で終了します。

gum confirm && rm file.txt || echo " File not removed " 

ファイル

ファイル ツリーからファイルを選択するようにユーザーに求めます。

EDITOR $( gum file $HOME ) 

ページャ

行番号と完全にカスタマイズ可能なビューポートを備えた長い文書をスクロールします。

gum pager < README.md

スピン

スクリプトまたはコマンドの実行中にスピナーを表示します。指定されたコマンドが終了すると、スピナーは自動的に停止します。

コマンドの出力を表示またはパイプするには、 --show-outputフラグを使用します。

gum spin --spinner dot --title " Buying Bubble Gum... " -- sleep 5

使用可能なスピナー タイプには、 line 、 dot 、 minidot 、 jump 、 pulse 、 points 、 globe 、 moon 、 monkey 、 meter 、 hamburgerが含まれます。

テーブル

表形式のデータから行を選択します。

gum table < flavors.csv | cut -d ' , ' -f 1

スタイル

1 つのコマンドで、任意の文字列を任意のレイアウトできれいに出力します。

gum style 
	--foreground 212 --border-foreground 212 --border double 
	--align center --width 50 --margin " 1 2 " --padding " 2 4 " 
	' Bubble Gum (1¢) ' ' So sweet and so fresh! ' 

参加する

テキストを縦または横に結合します。このコマンドをgum styleで使用して、レイアウトときれいな出力を構築します。

ヒント: joinコマンドの引数としてガム スタイルを使用する場合は、改行 ( n ) を保持するために、 gum styleの出力を常に引用符で囲みます。

I= $( gum style --padding " 1 5 " --border double --border-foreground 212 " I " )
LOVE= $( gum style --padding " 1 4 " --border double --border-foreground 57 " LOVE " )
BUBBLE= $( gum style --padding " 1 8 " --border double --border-foreground 255 " Bubble " )
GUM= $( gum style --padding " 1 5 " --border double --border-foreground 240 " Gum " )

I_LOVE= $( gum join " $I " " $LOVE " )
BUBBLE_GUM= $( gum join " $BUBBLE " " $GUM " )
gum join --align center --vertical " $I_LOVE " " $BUBBLE_GUM " 

形式

formatテキストの本文を処理してフォーマットします。 gum format 、マークダウン、テンプレート文字列、名前付き絵文字を解析できます。

 # Format some markdown
gum format -- " # Gum Formats " " - Markdown " " - Code " " - Template " " - Emoji "
echo " # Gum Formatsn- Markdownn- Coden- Templaten- Emoji " | gum format

# Syntax highlight some code
cat main.go | gum format -t code

# Render text any way you want with templates
echo ' {{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }} ' 
    | gum format -t template

# Display your favorite emojis!
echo ' I :heart: Bubble Gum :candy: ' | gum format -t emoji

テンプレート ヘルパーの詳細については、Termenv ドキュメントを参照してください。名前付き絵文字の完全なリストについては、GitHub API を参照してください。

ログ

log charmbracelet/logライブラリを使用して、さまざまなレベルとスタイルを使用してメッセージを端末に記録します。

 # Log some debug information.
gum log --structured --level debug " Creating file... " name file.txt
# DEBUG Unable to create file. name=temp.txt

# Log some error.
gum log --structured --level error " Unable to create file. " name file.txt
# ERROR Unable to create file. name=temp.txt

# Include a timestamp.
gum log --time rfc822 --level error " Unable to create file. "

使用可能な--time形式については、Go timeパッケージを参照してください。

詳しい使用方法については、 charmbracelet/log参照してください。

例

日常のワークフローでgumを使用する方法:

実際の使用例については、サンプル ディレクトリを参照してください。

• コミットメッセージを書きます。

git commit -m " $( gum input --width 50 --placeholder " Summary of changes " ) " 
           -m " $( gum write --width 80 --placeholder " Details of changes " ) "

• $EDITORでファイルを開く

 $EDITOR $( gum filter )

• tmuxセッションに接続する

SESSION= $( tmux list-sessions -F # S | gum filter --placeholder " Pick session... " )
tmux switch-client -t $SESSION || tmux attach -t $SESSION

• git履歴からコミット ハッシュを選択する

git log --oneline | gum filter | cut -d ' ' -f1 # | copy

• シンプルなskateパスワードセレクター。

 skate list -k | gum filter | xargs skate get

• パッケージをアンインストールする

brew list | gum choose --no-limit | xargs brew uninstall

• gitブランチをクリーンアップする

git branch | cut -c 3- | gum choose --no-limit | xargs git branch -D

• ghを使用して GitHub プル リクエストをチェックアウトする

gh pr list | cut -f1,2 | gum choose | cut -f1 | xargs gh pr checkout

• シェル履歴からコマンドをコピー

gum filter < $HISTFILE --height 20

• sudo置換

 alias please= " gum input --password | sudo -nS " 

フィードバック

このプロジェクトについてのご意見をお待ちしております。お気軽にメモを残してください。

• ツイッター
• フェディバース
• 不和

ライセンス

マサチューセッツ工科大学

---

チャームの一部。

Charm热爱开源 • Charmはオープンソースが大好きです