hub / github.com/afx-team/petercat
github.com/afx-team/petercat @1.0.0
Chat with this repo
703 symbols
2,401 edges
264 files
30 documented · 4%
● updated 13mo ago1.0.0 · 2024-12-04★ 1,49229 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
PeterCat
コミュニティメンテナと開発者のために特別に設計されたインテリジェントQ&Aボットソリューション。
🏠 ホームページ
✨ 特徴
会話型Q&Aエージェントの構成システム、自ホスト型デプロイメントソリューション、および便利なオールインワンアプリケーションSDKを提供し、GitHubリポジトリのためのインテリジェントQ&Aボットをワンクリックで作成し、さまざまな公式ウェブサイトやプロジェクトに迅速に統合し、コミュニティのためのより効率的な技術サポートエコシステムを提供します。
会話で作成
リポジトリのアドレスまたは名前を提供するだけで、Peter Catがボットの作成プロセス全体を自動的に完了します。
自動化されたナレッジベース
ボットが作成されると、関連するすべてのGitHubドキュメントと問題が自動的にナレッジベースに追加され、ボットの知識源となります。
マルチプラットフォーム統合
公式ウェブサイトへのSDK統合やGitHubリポジトリへのワンクリックインストールなど、さまざまな統合オプションを提供します。
 |
 |
|---|---|
エージェントワークフロー
📦 自ホスト型デプロイメント
デプロイメントソリューション: AWS + Supabase
完全なガイドはこちらで見つけることができます: - Self-Hosting - Start the Service Locally - Self-Hosting - Deploy to AWS
⚙️ 環境変数
プロジェクトには環境変数の設定が必要です:
クライアント
.env.local
| 環境変数 | タイプ | 説明 | 例 |
|---|---|---|---|
NEXT_PUBLIC_API_DOMAIN |
必須 | バックエンドサービスのAPIドメイン | https://api.petercat.ai |
サーバー
.env
| 環境変数 | タイプ | 説明 | 例 |
|---|---|---|---|
| 基本アプリケーション環境変数 | |||
API_URL |
必須 | バックエンドサービスのAPIドメイン | https://api.petercat.ai |
WEB_URL |
必須 | フロントエンドウェブサービスのドメイン | https://petercat.ai |
STATIC_URL |
必須 | 静的リソースドメイン | https://static.petercat.ai |
| AWS関連環境変数 | |||
AWS_GITHUB_SECRET_NAME |
必須 | AWSシークレットファイル名 | prod/githubapp/petercat/pem |
AWS_STATIC_SECRET_NAME |
オプション | AWSが管理するCloudFrontのプライベートキーの名前。設定されている場合、CloudFrontの署名付きURLが使用され、リソースが保護されます。詳細については、AWSドキュメントを参照してください。 | prod/petercat/static |
AWS_LLM_TOKEN_SECRET_NAME |
オプション | AWSが管理するLLM署名プライベートキーの名前。設定されている場合、PetercatはRSAアルゴリズムを使用してユーザーのLLMトークンを管理します。 | prod/petercat/llm |
AWS_LLM_TOKEN_PUBLIC_NAME |
オプション | AWSが管理するLLM署名公開キーの名前。設定されている場合、PetercatはRSAアルゴリズムを使用してユーザーのLLMトークンを管理します。 | prod/petercat/llm/pub |
AWS_STATIC_KEYPAIR_ID |
オプション | AWS CloudFrontのキーID。設定されている場合、CloudFrontの署名付きURLが使用され、リソースが保護されます。詳細については、AWSドキュメントを参照してください。 | APKxxxxxxxx |
S3_TEMP_BUCKET_NAME |
必須 | 一時的な画像ファイル用のAWS S3バケット | xxx-temp |
SQS_QUEUE_URL |
必須 | AWS SQSキューURL | https://sqs.ap-northeast-1.amazonaws.com/xxx/petercat-task-queue |
| Supabase関連環境変数 | |||
SUPABASE_URL |
必須 | SupabaseサービスURL、こちらで見つけることができます | https://***.supabase.co |
SUPABASE_SERVICE_KEY |
必須 | Supabaseサービスキー、こちらで見つけることができます | {{SUPABASE_SERVICE_KEY}} |
| Auth0関連環境変数 | |||
AUTH0_DOMAIN |
必須 | Auth0ドメイン、Auth0 / Application / Basic Informationから取得 | petercat.us.auth0.com |
AUTH0_CLIENT_ID |
必須 | Auth0クライアントID、Auth0 / Application / Basic Informationから取得 | artfiUxxxx |
AUTH0_CLIENT_SECRET |
必須 | Auth0クライアントシークレット、Auth0 / Application / Basic Informationから取得 | xxxx-xxxx-xxx |
API_IDENTIFIER |
必須 | Auth0 API識別子 | https://petercat.us.auth0.com/api/v2/ |
| LLM関連環境変数 | |||
OPENAI_API_KEY |
必須 | OpenAI APIキー | sk-xxxx |
OPENAI_BASE_URL |
オプション | APIリクエストのためのベースURL。プロキシやサービスエミュレーターを使用する場合のみ指定します。 | https://api.openai.com/v1 |
GEMINI_API_KEY |
オプション | Gemini APIキー | xxxx |
TAVILY_API_KEY |
オプション | Tavily APIキー | tvly-xxxxx |
| GitHub App登録環境変数 | |||
X_GITHUB_APP_ID |
オプション | GitHub App ID | 123456 |
X_GITHUB_APPS_CLIENT_ID |
オプション | GitHub AppクライアントID | Iv1.xxxxxxx |
X_GITHUB_APPS_CLIENT_SECRET |
オプション | GitHub Appクライアントシークレット | xxxxxxxx |
| レート制限構成 | |||
RATE_LIMIT_ENABLED |
オプション | レート制限が有効かどうか | True |
RATE_LIMIT_REQUESTS |
オプション | レート制限のリクエスト数 | 100 |
RATE_LIMIT_DURATION |
オプション | レート制限の期間（分単位） | 1 |
🤝 貢献
Peter Catはyarnをパッケージマネージャーとして使用しています。
git clone https://github.com/petercat-ai/petercat.git
# 依存関係をインストール
yarn run bootstrap
# クライアントをデバッグ
yarn run client
# アシスタントをデバッグ
yarn run assistant
# サーバーをデバッグ
yarn run server
# ローカルでウェブサイトを開始
yarn run client:server
# ローカルでアシスタントコンポーネントを開始
yarn run assistant:server
# アシスタントをビルド
cd assistant
yarn run build
npm publish
# Dockerビルド
yarn run build:docker
# PyPIビルド
yarn run build:pypi
yarn run publish:pypi
💼 エンタープライズ統合
プロジェクトのアドレス、使用シナリオ、使用頻度などの情報をpetercat.assistant@gmail.com に送信してください。
📧 問題の報告
Peter Catはまだ成長段階にあり、時折「癇癪」を起こすことがあります。以下のチャンネルを通じて問題を報告してください：
- [Submit an Issue(https://github.com/petercat-ai/petercat/issues/new/choose)
- Discussions
👬 貢献者
📄 ライセンス
MIT@PeterCat
Extension points exported contracts — how you extend this code
LangProps (Interface)(no doc)
client/components/LangSwitcher.tsx
CollapseProps (Interface)
(no doc)
client/app/factory/edit/components/Collapse.tsx
ThoughtChainProps (Interface)
(no doc)
assistant/src/ThoughtChain/index.tsx
FullPageSkeletonProps (Interface)
(no doc)
client/components/FullPageSkeleton.tsx
PublicSwitcherProps (Interface)
(no doc)
client/app/factory/edit/components/PublicSwitcher.tsx
AssistantProps (Interface)
(no doc)
assistant/src/Assistant/index.tsx
BotInfoCardProps (Interface)
(no doc)
client/components/BotInfoCard.tsx
TaskContext (Interface)
(no doc)
client/app/factory/edit/components/TaskContext.tsx
Core symbols most depended-on inside this repo
get_env_variablecalled by 53
petercat_utils/utils/env.py
execute
called by 52
server/event_handler/issue.py
get_client
called by 32
petercat_utils/db/client/supabase.py
useGlobal
called by 8
client/app/contexts/GlobalContext.tsx
get_text
called by 8
server/i18n/translations.py
get_bot_by_id
called by 7
server/agent/bot/get_bot.py
getColorClass
called by 7
assistant/src/ThoughtChain/index.tsx
get_table
called by 6
petercat_utils/rag_helper/git_task.py
Shape
Languages
Python60%
TypeScript40%
Modules by API surface
server/bot/router.py22 symbols
server/scripts/envs.py18 symbols
petercat_utils/data_class.py18 symbols
server/rag/router.py16 symbols
client/app/services/BotsController.ts16 symbols
client/app/hooks/useBot.ts15 symbols
server/auth/router.py13 symbols
server/user/router.py12 symbols
server/event_handler/pull_request.py12 symbols
petercat_utils/rag_helper/git_task.py11 symbols
assistant/src/interface/contentMessage.interface.ts11 symbols
server/event_handler/discussion.py10 symbols
For agents
$ claude mcp add petercat \
-- python -m otcore.mcp_server <graph>