ドキュメント再編の一環として、このページは段階的に廃止されます。
このカードをクリックして、最新情報が含まれる更新版にリダイレクトしてください。
新しいドキュメントに不一致や改善が必要な箇所を見つけた場合は、ページ下部の「問題を報告」ボタンを使用してください。
dify
にリネームし、/usr/local/bin
パスにコピーした場合、以下のコマンドを実行して新しいプラグインプロジェクトを作成できます。
プラグイン名の長さは1〜128文字で、文字、数字、ダッシュ、アンダースコアのみを使用できます。
Extension
タイプのプラグインテンプレートを使用します。プラグインに精通している開発者であれば、テンプレートを使用せずに、APIドキュメントを参照して様々なタイプのプラグイン開発を進めることができます。
ターミナル内で方向キーを使って権限を選択し、「Tab」キーで権限を付与します。すべての権限項目をチェックした後、Enterキーを押してプラグインの作成を完了します。システムが自動的にプラグインのプロジェクトコードを生成します。
GUIDE.md
: プラグインの作成プロセスを説明する簡単なチュートリアルです。README.md
: 現在のプラグインに関する情報です。このプラグインの概要や使用方法をこのファイルに記述する必要があります。_assets
: 現在のプラグインに関連するすべてのマルチメディアファイルを保存します。endpoints
: CLIのガイドに従って作成されるExtension
タイプのプラグインテンプレートです。このディレクトリには、すべてのエンドポイントの機能実装コードが格納されています。group
: 秘密鍵のタイプ、多言語設定、API定義ファイルのパスを指定します。main.py
: プロジェクト全体のエントリポイントとなるファイルです。manifest.yaml
: プラグインの基本設定ファイルです。このプラグインに必要な権限、拡張機能の種類などの設定情報が含まれています。requirements.txt
: Python環境の依存関係を記述します。endpoints/test_plugin.yaml
を編集し、以下のコードを参考に変更してください。
/neko
、リクエストメソッドをGETタイプとして定義するものです。プラグインの機能実装コードは、endpoints/test_plugin.py
ファイルに記述します。
endpoints/test_plugin.py
ファイルに記述します。以下のサンプルコードを参考にしてください。
.env.example
ファイルをコピーして.env
にリネームします。そして、取得したリモートサーバーのアドレスやデバッグキーなどの情報を.env
ファイルに記入してください。
.env
ファイルの内容:
python -m main
コマンドを実行してプラグインを起動します。プラグインページで、このプラグインがワークスペースにインストールされたことを確認できます。他のチームメンバーもこのプラグインにアクセス可能です。
api_key
などの情報を任意で入力します。自動生成されたURLにアクセスすると、プラグインが提供するウェブサービスが表示されます。
neko.difypkg
というファイルが生成されます。このファイルが最終的なプラグインパッケージです。