trapipe

traQ BOTが購読したメッセージをシェルの標準出力にパイプします。
trapipeを使用することで、CLIをtraQに組み込むことができるようになります。
CLIがOSに影響を及ぼす機能を持っている場合、traQから間接的に実行される可能性に注意してください。

Install

go install github.com/ras0q/trapipe@latest

COPY --from=ghcr.io/ras0q/trapipe /bin/trapipe /bin/trapipe

Usage

$ trapipe -h
Usage: trapipe --access-token=STRING <command> [flags]

Flags:
  -h, --help                           Show context-sensitive help.
      --access-token=STRING            BOT Access Token ($TRAQ_BOT_ACCESS_TOKEN)
      --ws-origin="wss://q.trap.jp"    traQ Websocket Origin ($TRAQ_WS_ORIGIN)

Commands:
  receive --access-token=STRING [flags]
    Receive messages from traQ server (default)

  send --access-token=STRING --channel-id=STRING [flags]
    Send a message to traQ server

Run "trapipe <command> --help" for more information on a command.

Use with any CLIs

TRAQ_BOT_ACCESS_TOKEN="your access token"

trapipe receive -t "{{ .Message.ChannelID }} {{ .Message.PlainText }}" |
  while read -r channel_id mention args; do
    [ "$mention" = "@BOT_AWESOME" ] \
    && my-awesome-cli $args | trapipe send --channel-id "$channel_id"
  done

With jq

trapipe receive -t "{{ json . }}" | jq -r --unbuffered '
   (.message.plainText | split(" ")) as $args
   | select(.message.embedded[]?.raw == $args[0])
   | [.message.channelId, ($args[1:] | join(" "))]
   | @tsv
   ' |
  while IFS=$'\t' read -r channel_id args; do
    my-awesome-cli $args | trapipe send --channel-id $channel_id
  done

Use within Docker

trapipe は以下の Docker イメージを提供しています。

• trapipe (Base: scratch)
• trapipe:alpine (Base: alpine)
• trapipe:golang (Base: golang)

詳しくは Packages を参照してください。

シェルが使用可能なイメージでは、 ENTRYPOINT にペイロードを読み込む機能が組み込まれています (./docker-entrypoint.sh) 。 CMD に実行したいコマンドを与えることで、すぐにBOTを動かすことが可能です。 CMD に加え、最後の引数に MESSAGE_CREATED イベントの JSON ペイロードが渡されることに注意してください。

Dockerfile

FROM trapipe:alpine

COPY ./test.sh ./test.sh
# BOT が MESSAGE_CREATED イベントを受け取るたびに `./test.sh '{"eventTime": ..., "message": ...}'` が実行されます。
CMD ["./test.sh"]

shell

docker build -t my-awesome-image .
docker run -e TRAQ_BOT_ACCESS_TOKEN="your access token" my-awesome-image