Lexiconの公開

Lexiconを世界と共有する

goatの利用

Lexiconは機械可読かつネットワークアクセス可能なよう設計されています。現時点ではレキシコンがネットワーク上で利用可能であることは必須ではありませんが、利用者が単一の正規かつ信頼できる表現にアクセスできるよう、レキシコンを公開することを強く推奨します。

コマンドラインツールgoatを使って、Lexiconを作成・公開できます。Lexicon関連の機能はgoat lexにあります。

  • スキーマを公開してATネットワークと同期する
  • スキーマの差分比較、lint、およびスキーマ進化ルールの検証

goatはmacOSとLinuxでHomebrewからインストールできます。

brew install goat

プロジェクトディレクトリで既存のLexiconをダウンロードすると、./lexicons/にJSONファイルとして保存されます。

$ goat lex pull com.atproto.repo.strongRef com.atproto.moderation. app.bsky.actor.profile
 🟢 com.atproto.repo.strongRef
 🟢 com.atproto.moderation.defs
 🟢 com.atproto.moderation.createReport
 🟢 app.bsky.actor.profile

goat lex new recordを使って新しいLexiconレコードを作成できます。

$ goat lex new record dev.project.thing

$ open ./lexicons/dev/project/thing.json

最後にgoat lex publishで公開します。

$ goat lex publish
 🟢 dev.project.thing

新しいLexiconを作成する際は、Lexiconスタイルガイドを参照してください。

関連・参考資料