pikasay
v0.1.0
Published
ナキウサギがターミナル上で一言しゃべるCLI
Downloads
161
Maintainers
Readme
pikasay
ナキウサギが、入力したメッセージをターミナル上で一言しゃべる小さなCLIです。 通常・成功・注意・失敗の4モードを、表情と鳴き声、控えめな色で伝えます。
/\_/\
( •ᴗ• ) ぴ。
/ >🍃
こんにちは必要な環境
- Node.js 22以上
- npm
インストール
npmへ公開後は、グローバルインストールして利用できます。
npm install --global pikasay
pikasay "こんにちは"インストールせずに実行する場合はnpxを利用できます。
npx pikasay "こんにちは"開発環境のセットアップ
npm install
npm run build
npm test
npm run lint
npm run format:check自動修正を含むフォーマットはnpm run format、lint・format確認・テストの一括実行はnpm run checkです。ビルド後はnode dist/cli.jsで実行できます。npmパッケージとしてローカルインストールまたはリンクした場合のコマンド名はpikasayです。以下ではそのコマンド名で説明します。
使い方
引数からメッセージを渡せます。複数の引数は空白で結合されます。
pikasay "こんにちは"
pikasay "複数の" "引数です"標準入力も利用できます。入力内の改行と空行は維持され、各行が端末幅を超える場合だけ追加で折り返されます。メッセージ引数がある場合は、標準入力より引数を優先して標準入力を待ちません。
printf '1行目です\n2行目です\n3行目です\n' | pikasay --mood success空または空白だけの入力はメッセージとして扱いません。入力は引数と標準入力のどちらもUTF-8換算で最大65,536 bytesです。上限を超えた場合は標準エラーへ案内を表示し、終了コード1で終了します。短いメッセージを表示するCLIとして十分な余裕を確保しつつ、巨大な誤入力を保持し続けないための制限です。
-から始まる文字列はオプションとして解釈されます。メッセージとして渡す場合は、オプション終端の--より後へ指定してください。
pikasay -- "--helpではないメッセージ"モード
--mood <normal|success|warning|error>で表示を切り替えます。未指定時はnormalです。モード名は小文字で指定してください。
normal — 穏やかな通常表示:
/\_/\
( •ᴗ• ) ぴ。
/ >🍃
作業を始めるよsuccess — うれしそうな成功表示:
/\_/\
( ^ᴗ^ ) ぴ!
/ >🍃
テスト、通ったよwarning — 少し不安そうな注意表示:
/\_/\
( •︵• ) ぴぃ…
/ >🍃
未コミットの変更がありますerror — 困った表情の失敗表示:
/\_/\
( >︵< ) ぴぎゃー!
/ >🍃
ビルドに失敗しました実行例:
pikasay "こんにちは"
pikasay --mood success "テスト、通ったよ"
echo "確認が必要です" | pikasay --mood warning
pikasay --mood error "ビルドに失敗しました"errorは表示上のモードです。正しく表示できた場合の終了コードは0です。不正なモード名は利用可能なモードを標準エラーへ示し、非ゼロで終了します。
色を無効にする
色はナキウサギのAAと鳴き声だけに付き、色がなくても表情と鳴き声でモードを識別できます。次のいずれかの場合、ANSIカラーを出力しません。
--no-colorを指定した場合NO_COLOR環境変数が存在する場合(値は問いません)- 標準出力がTTYではない場合(パイプやリダイレクトなど)
pikasay --no-color --mood success "テスト成功"
NO_COLOR=1 pikasay --mood warning "確認が必要です"オプション
--mood <normal|success|warning|error> 表情・雰囲気を指定(既定値: normal)
--no-color ANSIカラーを無効化
-h, --help ヘルプを表示
-v, --version バージョンを表示pikasay --help
pikasay --versionローカル開発時は、上記のpikasayをnode dist/cli.jsへ読み替えてください。
--helpは、--より前にあればほかの引数より優先してヘルプを表示し、正常終了します。--helpがなく--versionがある場合も同様にバージョンを表示して正常終了します。不明なオプション、値のない--mood、不正なモード、空入力、入力上限超過は標準エラーへ案内を表示し、終了コード1で終了します。
ライセンス
MIT Licenseです。
Copyright (c) 2026 k-logic563
ナキウサギのAAとメッセージ文言は、このプロジェクトで作成したオリジナル素材です。
リンク
- GitHub: https://github.com/k-logic563/pikasay
- Issues: https://github.com/k-logic563/pikasay/issues
