Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ Feature requests are welcome! Please:

We welcome code contributions! See the [Development Setup](#development-setup) section below to get started.

***Reference Doc***

> Multi-agent system architecture: [CORE_ARCHITECTURE](../docs/CORE_ARCHITECTURE.md)
> Configuration documentation: [CONFIGURATION_GUIDE](../docs/CONFIGURATION_GUIDE.md)


## Development Setup

### Prerequisites
Expand Down Expand Up @@ -68,6 +74,8 @@ Refer to [Configuration Guide](../docs/CONFIGURATION_GUIDE.md) for details.
**Install backend dependencies:**

```bash
# Install pytest dependencies for testing

# Method 1: Using sync (recommended)
cd python
uv sync --extra dev
Expand Down Expand Up @@ -360,6 +368,9 @@ docs: update installation instructions
## Pull Request Process

1. **Create a feature branch**

Fork the project and use the `git clone` command to download it


```bash
git checkout -b feat/your-feature-name
Expand Down Expand Up @@ -414,6 +425,17 @@ docs: update installation instructions
- Address any requested changes
- Once approved, your PR will be merged

## 🔥 ValueCell Dev Program

Build with us & get rewarded. Land 3 commits in the last month, and we will contact you via our official email (public@valuecell.ai).

You will get:

**💰 $100 Cash for API Keys and AI Coding Subscription**

**🚀 Become a core contributor and participate in the project's future profits**


## Questions?

If you have questions:
Expand All @@ -424,4 +446,5 @@ If you have questions:

---

Thank you for contributing to ValueCell! 🚀
Thank you for contributing to ValueCell! 🚀🚀🚀

51 changes: 34 additions & 17 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,13 @@


# ValueCell
ValueCellは、金融アプリケーション向けのコミュニティ主導型マルチエージェントプラットフォームです
ValueCellは、金融アプリケーション向けのコミュニティ主導型マルチエージェントプロダクトです。私たちの目標は、世界最大の分散型金融エージェントコミュニティを構築することです

ポートフォリオ管理を支援するトップクラスの投資エージェントチームを提供します。
ポートフォリオ管理を支援するトップクラスの投資エージェントチームを提供します。これにより、銘柄選別、リサーチ、追跡、および取引の完了を支援します。

Discord コミュニティへのご参加をお待ちしています。使用中に発生した問題についてのご意見をお寄せいただき、さらに多くの開発者にご参加いただけますようお願いします🔥🔥🔥

>注意: ValueCellチームメンバーがコミュニティ参加者に主動的に連絡することはありません。このプロジェクトは技術交流のみを目的としています。投資にはリスクが伴います。⚠️

# スクリーンショット

Expand Down Expand Up @@ -63,16 +67,16 @@ ValueCellは、金融アプリケーション向けのコミュニティ主導


## マルチエージェントシステム
- **DeepResearch Agent**: SECファイリングを自動的に取得・分析し、正確なデータインサイトと解釈可能なサマリーを生成
- **Auto Trading Agent**: 複数の暗号資産とAI駆動の取引戦略
- **DeepResearch Agent**: 株式の基本情報ドキュメントを自動的に取得・分析し、正確なデータインサイトと解釈可能なサマリーを生成
- **Auto Trading Agent**: 複数の暗号資産とAI駆動の取引戦略をサポート、技術指標に基づいた自動取引を作成
- **Trading Agents**: 市場分析、センチメント分析、ニュース分析、ファンダメンタル分析を担当するエージェント
- **AI-Hedge-Fund**: エージェントが協力して包括的な金融インサイトを提供
- **その他**: さらに多くのエージェントを計画中...

## 柔軟な統合
- **複数のLLMプロバイダー**: OpenRouter、OpenAI、Anthropic、Google、Ollamaをサポート
- **複数のLLMプロバイダー**: OpenRouter、SiliconFlow、GoogleおよびOpenAIをサポート
- **人気の市場データ**: 米国市場、暗号市場、香港市場、中国市場など
- **マルチエージェントフレームワーク対応**: A2AプロトコルによるLangchain、Agnoをサポート
- **マルチエージェントフレームワーク対応**: A2AプロトコルによるLangchain、Agnoをサポート、研究開発の統合を行う

# クイックスタート

Expand Down Expand Up @@ -104,18 +108,21 @@ ValueCellは包括的なWebインターフェースを備えたPythonベース

## 設定

詳細な設定情報については、[CONFIGURATION_GUIDE](./docs/CONFIGURATION_GUIDE.md)を参照してください。

### モデルプロバイダー
`.env`ファイルを編集して、お好みのモデルプロバイダーを設定してください:

- **主なサポート**: [OpenRouter](https://openrouter.ai) - 現在、ほとんどのエージェントで主にサポートされているプロバイダー
- **TradingAgents**はメモリの使用が必要です。OpenRouterをAPIキーとして使用する場合、Embeddingモデルのパラメータ設定が必要になります(OpenRouterはEmbeddingモデルをサポートしていないため)。TradingAgents/.env.exampleファイルを参照し、その設定をルートディレクトリの.envファイルにコピーしてください。
- **シンプルセットアップ**: モデルプロバイダーの API キーのみを設定してください

- **高度な設定**: リサーチタイプのエージェントの場合、より多くの環境変数を設定する必要があります。詳細は `.env.example` ファイルを参照してください

- **公式推奨**: OpenRouter + 埋め込みモデルを提供する任意のサプライヤーを設定してください。理由:プロバイダー間のモデルの高速切り替えが可能であり、RAG+Memory AI機能を提供します。

要件と好みに基づいて、お好みのモデルとプロバイダーを選択してください。

## アプリケーションの実行

完全なアプリケーションスタック(フロントエンド、バックエンド、エージェント)を起動します:
完全なアプリケーション(フロントエンド、バックエンド、エージェント)を起動します:

### Linux / Macos
```bash
Expand All @@ -139,14 +146,25 @@ bash start.sh
---

**注意**: アプリケーションを実行する前に、すべての前提条件がインストールされ、環境変数が適切に設定されていることを確認してください。
長期間更新がない場合は、プロジェクト内のデータベースファイル(`lancedb/`、`valuecell.db`、`.knowledgebase/`)を削除してから再起動できます。


# 開発者

すべての開発者をDiscordディスカッショングループに招待し、コミュニティのRoadMapと将来のコミュニティコントリビューター権利計画について定期的に交流します

開発プロセスと標準の詳細については、[CONTRIBUTING.md](.github/CONTRIBUTING.md)を参照してください

# ロードマップ

## 🤖 強化されたエージェント機能
### 取引能力
- **暗号通貨**: より多くの取引所をサポート
- **証券**: AI証券取引を段階的にサポート

### 市場拡大
- **ヨーロッパ市場**: FTSE、DAX、CAC 40などのヨーロッパ取引所のサポートを追加
- **アジア市場**: 日経、ハンセン、上海総合指数、新興アジア市場へのカバレッジ拡大
- **アジア市場**: 日経、新興アジア市場へのカバレッジ拡大
- **商品市場**: 石油、金、銀、農産物の分析
- **外国為替市場**: 主要通貨ペアとクロスカレンシー分析

Expand All @@ -160,9 +178,13 @@ bash start.sh
- **スケジュールレポート**: 日次/週次/月次ポートフォリオサマリー
- **イベント駆動型通知**: 決算発表、配当発表、規制変更
- **カスタムトリガー**: ユーザー定義の条件としきい値
- **マルチチャネル配信**: メール、SMS、Slack、Discord、Webhook統合
- **マルチチャネル配信**: Discord と Webhook 統合

## ⚙️ 製品設定とパーソナライゼーション
### マルチプラットフォーム製品
- **デスクトップサポート**: デスクトップとクライアント機能を段階的にサポート
- **データベースホットアップデート**: 互換性アップグレードの段階的サポート

### 国際化(i18n)
- **多言語サポート**: 英語、中国語(簡体字/繁体字)、日本語、韓国語、スペイン語、フランス語
- **ローカライズされた市場データ**: 地域固有の金融用語とフォーマット
Expand All @@ -172,8 +194,6 @@ bash start.sh
### トークンと認証管理
- **APIキー管理**: サードパーティAPIキーの安全な保存とローテーション
- **OAuth統合**: 主要な金融データプロバイダーのサポート
- **レート制限**: インテリジェントなリクエストスロットリングとクォータ管理
- **マルチテナントアーキテクチャ**: エンタープライズグレードのユーザー分離とセキュリティ

### ユーザー設定とカスタマイズ
- **投資プロファイル**: リスク許容度、投資期間、戦略の好み
Expand All @@ -190,14 +210,11 @@ bash start.sh
## 🔧 ValueCell SDK開発
### コアSDK機能
- **Python SDK**: エージェント統合とカスタマイズのための包括的なライブラリ
- **REST APIラッパー**: 自動認証付きの簡易HTTPクライアント
- **WebSocketサポート**: リアルタイムデータストリーミングと双方向通信

### エージェント統合フレームワーク
- **プラグインアーキテクチャ**: サードパーティエージェントとツールの簡単な統合
- **エージェントレジストリ**: コミュニティ貢献エージェントのマーケットプレイス
- **カスタムエージェントビルダー**: ローコード/ノーコードエージェント作成ツール
- **エージェントオーケストレーション**: ワークフロー管理とエージェント調整

### 開発者ツールとドキュメント
- **インタラクティブAPIエクスプローラー**: ライブテスト機能付きSwagger/OpenAPIドキュメント
Expand Down
51 changes: 34 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,13 @@


# ValueCell
ValueCell is a community-driven, multi-agent platform for financial applications.
ValueCell is a community-driven, multi-agent platform for financial applications. Our mission is to build the world's largest decentralized financial agent community.

It provides a team of TOP investment Agents to help manage your portfolio.
It provides a team of TOP investment Agents to help you with stock selection, research, tracking, and even trading.

Welcome to join our Discord community to share feedback and issues you encounter, and invite more developers to contribute 🔥🔥🔥

>Note: ValueCell team members will never proactively contact community participants. This project is for technical exchange only. Investing involves risk. ⚠️

# Screenshot

Expand Down Expand Up @@ -63,16 +67,16 @@ It provides a team of TOP investment Agents to help manage your portfolio.


## Multi-Agent System
- **DeepResearch Agent**: Automatically retrieve and analyze SEC filings to generate accurate data insights and interpretable summaries
- **Auto Trading Agent**: multiple crypto assets and AI-powered trading strategies
- **DeepResearch Agent**: Automatically retrieve and analyze fundamental documents to generate accurate data insights and interpretable summaries
- **Auto Trading Agent**: Support for multiple crypto assets and AI-powered trading strategies, creating automated trading based on technical indicators
- **Trading Agents**: Agents work for market analysis, sentiment analysis, news analysis, and fundamentals analysis
- **AI-Hedge-Fund**: Agents collaborate to provide comprehensive financial insights
- **Others**: More agents are in planning...

## Flexible Integrations
- **Multiple LLM Providers**: Support OpenRouter, OpenAI, Anthropic, Google and Ollama
- **Multiple LLM Providers**: Support OpenRouter, SiliconFlow, Google and OpenAI
- **Popular Market Data**: Cover US market, Crypto market, Hong Kong market, China market and more
- **Multi-Agent Framework Compatible**: Support Langchain, Agno by A2A Protocol
- **Multi-Agent Framework Compatible**: Support Langchain, Agno by A2A Protocol for research and development integration

# Quick Start

Expand Down Expand Up @@ -104,18 +108,23 @@ For optimal performance and streamlined development, we recommend installing the

## Configuration

More detailed configuration information can be found at [CONFIGURATION_GUIDE](./docs/CONFIGURATION_GUIDE.md)

### Model Providers
Configure your preferred model providers by editing the ⁠`.env` file:
Configure your preferred model providers by editing the `.env` file:

- **Simple Setup**: Just configure the model provider's API Key

- **Advanced Configuration**: For research-type agents, you need to configure more environment variables. Please refer to the `.env.example` file for details.

- **Primary Support**: [OpenRouter](https://openrouter.ai) - Currently the main supported provider for most agents
- **TradingAgents** requires the use of Memory. If you use OpenRouter as API key, configuring the Embedding model parameters will be needed (since OpenRouter does not support Embedding models). Please refer to the TradingAgents/.env.example file and copy its configuration into the .env file located in the root directory.
- **Official Recommendation**: Configure OpenRouter + any supplier that provides embedding models. Reason: This enables quick model switching across providers and provides RAG+Memory AI capabilities


Choose your preferred models and providers based on your requirements and preferences.

## Running the Application

Launch the complete application stack (frontend, backend, and agents):
Launch the complete application (frontend, backend, and agents):

### Linux / Macos
```bash
Expand All @@ -132,6 +141,11 @@ bash start.sh
- **Web UI**: Navigate to [http://localhost:1420](http://localhost:1420) in your browser
- **Logs**: Monitor application logs at `logs/{timestamp}/*.log` for detailed runtime information of backend services and individual agents

## Note

Before running the application, ensure all prerequisites are installed and environment variables are properly configured.
If it has been a long time since the last update, you can delete the database files in the project (`lancedb/`, `valuecell.db`, `.knowledgebase/`) and start again.

## Next Steps

Once the application is running, you can explore the web interface to interact with ValueCell's features and capabilities.
Expand All @@ -144,9 +158,13 @@ Once the application is running, you can explore the web interface to interact w
# Roadmap

## 🤖 Enhanced Agent Capabilities
### Trading Capabilities
- **Crypto**: Support more exchanges
- **Securities**: Gradually support AI securities trading

### Market Expansion
- **European Markets**: Add support for FTSE, DAX, CAC 40, and other European exchanges
- **Asian Markets**: Expand coverage to Nikkei, Hang Seng, Shanghai Composite, and emerging Asian markets
- **Asian Markets**: Expand coverage to Nikkei and emerging Asian markets
- **Commodity Markets**: Oil, Gold, Silver, Agricultural products analysis
- **Forex Markets**: Major currency pairs and cross-currency analysis

Expand All @@ -160,9 +178,13 @@ Once the application is running, you can explore the web interface to interact w
- **Scheduled Reports**: Daily/weekly/monthly portfolio summaries
- **Event-driven Notifications**: Earnings releases, dividend announcements, regulatory changes
- **Custom Triggers**: User-defined conditions and thresholds
- **Multi-channel Delivery**: Email, SMS, Slack, Discord, and webhook integrations
- **Multi-channel Delivery**: Discord and webhook integrations

## ⚙️ Product Configuration & Personalization
### Multi-platform Products
- **Desktop Support**: Gradually support desktop and client capabilities
- **Database Hot Updates**: Gradually support compatibility upgrades

### Internationalization (i18n)
- **Multi-language Support**: English, Chinese (Simplified/Traditional), Japanese, Korean, Spanish, French
- **Localized Market Data**: Region-specific financial terminology and formats
Expand All @@ -172,8 +194,6 @@ Once the application is running, you can explore the web interface to interact w
### Token & Authentication Management
- **API Key Management**: Secure storage and rotation of third-party API keys
- **OAuth Integration**: Support for major financial data providers
- **Rate Limiting**: Intelligent request throttling and quota management
- **Multi-tenant Architecture**: Enterprise-grade user isolation and security

### User Preferences & Customization
- **Investment Profile**: Risk tolerance, investment horizon, and strategy preferences
Expand All @@ -190,14 +210,11 @@ Once the application is running, you can explore the web interface to interact w
## 🔧 ValueCell SDK Development
### Core SDK Features
- **Python SDK**: Comprehensive library for agent integration and customization
- **REST API Wrapper**: Simplified HTTP client with automatic authentication
- **WebSocket Support**: Real-time data streaming and bidirectional communication

### Agent Integration Framework
- **Plugin Architecture**: Easy integration of third-party agents and tools
- **Agent Registry**: Marketplace for community-contributed agents
- **Custom Agent Builder**: Low-code/no-code agent creation tools
- **Agent Orchestration**: Workflow management and agent coordination

### Developer Tools & Documentation
- **Interactive API Explorer**: Swagger/OpenAPI documentation with live testing
Expand Down
Loading