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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -228,4 +228,8 @@ lancedb
logs
.knowledge
.txt

# Local configs
python/configs/

*.key
117 changes: 47 additions & 70 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ ValueCellは、金融アプリケーション向けのコミュニティ主導

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

機密情報はすべてローカルデバイスに保存され、コアデータのセキュリティが確保されます。

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

>注意: ValueCellチームメンバーがコミュニティ参加者に主動的に連絡することはありません。このプロジェクトは技術交流のみを目的としています。投資にはリスクが伴います。⚠️
Expand Down Expand Up @@ -84,89 +86,27 @@ p align="center">

# クイックスタート

## ユーザー向け
## 新規ユーザー向け

最新の ValueCell アプリケーション(MacOS または Windows 用)を GitHub の[リリースページ](https://github.com/ValueCell-ai/valuecell/releases)からダウンロードできます。また、公式ウェブサイト [https://valuecell.ai](https://valuecell.ai) からもダウンロードできます。

インストール後、初回使用時に、お好みのモデルプロバイダーを設定してください。アプリケーション内の指示またはドキュメントを参照してください。

## 開発者向け
ValueCellは包括的なWebインターフェースを備えたPythonベースのアプリケーションです。このガイドに従って、アプリケーションを効率的にセットアップして実行してください。

### 前提条件

最適なパフォーマンスと効率的な開発のために、以下のツールのインストールを推奨します:

**[uv](https://docs.astral.sh/uv/getting-started/installation/)** - Rustで構築された超高速Pythonパッケージおよびプロジェクトマネージャー
**[bun](https://github.com/oven-sh/bun#install)** - 高性能JavaScript/TypeScriptツールキット(ランタイム、バンドラー、テストランナー、パッケージマネージャーを含む)

### インストール

1. **リポジトリのクローン**

```bash
git clone https://github.com/ValueCell-ai/valuecell.git
cd valuecell
```

2. **環境変数の設定**

```bash
cp .env.example .env
```

APIキーと設定を`.env`ファイルに記入してください。この設定ファイルはすべてのエージェント間で共有されます。設定の詳細については、[設定ガイド](docs/CONFIGURATION_GUIDE.md) をご参照ください。

## 設定

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

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

- **シンプルセットアップ**: モデルプロバイダーの API キーのみを設定してください

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

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

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

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

### Linux / Macos
```bash
bash start.sh
```

### Windows (PowerShell)
```powershell
.\start.ps1
```

## インターフェースへのアクセス

- **Web UI**: ブラウザで[http://localhost:1420](http://localhost:1420)にアクセス
- **ログ**: バックエンドサービスと個々のエージェントの詳細な実行時情報については、`logs/{timestamp}/*.log`でアプリケーションログを確認

### 次のステップ

アプリケーションが起動したら、WebインターフェースでValueCellの機能を操作して探索できます。

## ライブ取引
### ライブ取引

- AIモデルの設定: Webインターフェースから AI モデルの API キーを追加します。
- 取引所の設定: Binance/HyperLiquid/OKX/Coinbase... の API 認証情報を設定します。
- ストラテジー作成: AIモデルと取引所を組み合わせてカスタム戦略を作成します。
- モニタリング&コントロール: 戦略の開始/停止を行い、パフォーマンスをリアルタイムで監視します。
- 注意:現在は先物取引のみをサポートしています(現物は1X先物として実装)。先物口座に十分な残高があることを確認してください

### サポートされている取引所
#### サポートされている取引所

| 取引所 | 備考 | ステータス |
| --- | --- | --- |
| **Binance** | 国際サイト [binance.com](binance.com) のみサポート(米国サイトは非対応)。USDT-M 先物(USDT証拠金契約)を使用します。先物口座に十分な USDT 残高があることを確認してください。取引ペア形式: `BTC/USDT` | ✅ テスト済み |
| **Hyperliquid** | 証拠金通貨として USDC のみサポートします。メインウォレットアドレス + API ウォレット秘密鍵認証を使用します([APIタブ](https://app.hyperliquid.xyz/API)から申請)。成行注文は自動的に IoC 指値注文に変換されます。取引ペア形式は手動で `SYMBOL/USDC` に調整する必要があります(例: `WIF/USDC`)。 | ✅ テスト済み |
| **OKX** | 認証には API Key、Secret、Passphrase が必要です。USDT証拠金契約をサポートします。取引ペア形式: `BTC/USDT` | ✅ テスト済み |
| **Binance** | 国際サイト [binance.com](binance.com) のみサポート(米国サイトは非対応)。USDT-M 先物(USDT証拠金契約)を使用します。先物口座に十分な USDT 残高があることを確認してください。取引ペア形式: `BTC/USDT`。注意:無期限先物口座の残高が0でないことを確認してください。API申請時はIPホワイトリストを追加してください(検索エンジンで`My IP`を検索して確認) | ✅ テスト済み |
| **Hyperliquid** | 証拠金通貨として USDC のみサポートします。メインウォレットアドレス + API ウォレット秘密鍵認証を使用します([APIタブ](https://app.hyperliquid.xyz/API)から申請)。成行注文は自動的に IoC 指値注文に変換されます。取引ペア形式は手動で `SYMBOL/USDC` に調整する必要があります(例: `WIF/USDC`)。メインウォレットアドレス+APIウォレット秘密鍵で設定。1取引あたり最低10U | ✅ テスト済み |
| **OKX** | 認証には API Key、Secret、Passphrase(OKXアカウントパスワード)が必要です。USDT証拠金契約をサポートします。取引ペア形式: `BTC/USDT` | ✅ テスト済み |
| Coinbase | USDT証拠金契約をサポートします。Coinbase International はまだサポートされていません。 | 🟡 部分的にテスト済み |
| Gate.io | USDT証拠金契約をサポートします。API Key と Secret が必要です。 | 🟡 部分的にテスト済み |
| MEXC | USDT証拠金契約をサポートします。API Key と Secret が必要です。 | 🟡 部分的にテスト済み |
Expand All @@ -183,6 +123,7 @@ bash start.sh
- アカウントの安全を確保するために、API キーを定期的にリセットする必要があります。

---

**注意**: アプリケーションを実行する前に、すべての前提条件がインストールされ、環境変数が適切に設定されていることを確認してください。
長期間更新がない場合は、ローカルデータを削除して再起動できます:
- LanceDB ディレクトリ(システムアプリディレクトリに保存。`.env` と同じ場所):
Expand All @@ -199,12 +140,48 @@ bash start.sh
- Windows: `%APPDATA%\\ValueCell\\valuecell.db`


# 開発者
## 開発者

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

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

ValueCellは包括的なWebインターフェースを備えたPythonベースのアプリケーションで、マルチプラットフォーム展開をサポートしています。以下の設定に従って、すぐに始めることができます。

## リポジトリのクローン

```bash
git clone https://github.com/ValueCell-ai/valuecell.git
cd valuecell
```

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

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

### Linux / Macos
```bash
bash start.sh
```

### Windows (PowerShell)
```powershell
.\start.ps1
```

### インターフェースへのアクセス

- **Web UI**: ブラウザで[http://localhost:1420](http://localhost:1420)にアクセス
- **ログ**: ターミナルで直接アプリケーションログを確認し、バックエンドサービスと個々のエージェントの詳細な実行時情報を取得

### 次のステップ

アプリケーションが起動したら、WebインターフェースでValueCellの機能を操作して探索できます。

### 設定

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

# ロードマップ

## 🤖 強化されたエージェント機能
Expand Down
134 changes: 54 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ ValueCell is a community-driven, multi-agent platform for financial applications

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

The system keeps all your sensitive information stored locally on your device, ensuring core data security.

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. ⚠️
Expand Down Expand Up @@ -85,93 +87,27 @@ Welcome to join our Discord community to share feedback and issues you encounter

# Quick Start

## For Users
## New Users

To get started quickly, download the latest ValueCell application for MacOS or Windows from the [Releases page](https://github.com/ValueCell-ai/valuecell/releases) on GitHub. You may also download the application from our official website: [https://valuecell.ai](https://valuecell.ai).

After installation, please configure your preferred model provider before using ValueCell for the first time. Refer to the instructions in the application or documentation as needed.

## For Developers
ValueCell is a Python-based application featuring a comprehensive web interface. Follow this guide to set up and run the application efficiently.

### Prerequisites

For optimal performance and streamlined development, we recommend installing the following tools:

**[uv](https://docs.astral.sh/uv/getting-started/installation/)** - Ultra-fast Python package and project manager built in Rust
**[bun](https://github.com/oven-sh/bun#install)** - High-performance JavaScript/TypeScript toolkit with runtime, bundler, test runner, and package manager

### Installation

1. **Clone the repository**

```bash
git clone https://github.com/ValueCell-ai/valuecell.git
cd valuecell
```

2. **Configure environment variables**

```bash
cp .env.example .env
```

Edit the `.env` file with your API keys and preferences. This configuration file is shared across all agents. See [Configuration Guide](docs/CONFIGURATION_GUIDE.md) for details.

## 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:

- **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.

- **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 (frontend, backend, and agents):

### Linux / Macos
```bash
bash start.sh
```

### Windows (PowerShell)
```powershell
.\start.ps1
```

## Accessing the Interface

- **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


## Next Steps

Once the application is running, you can explore the web interface to interact with ValueCell's features and capabilities.

## Live Trading
### Live Trading

- Configure AI Models: Add your AI Model API Key through the web interface.
- Configure Exchanges: Set up Binance/HyperLiquid/OKX/Coinbase... API credentials
- Create Strategies: Combine AI model with exchange to create custom strategies
- Monitor & Control: Start/stop traders and monitor performance in real-time
- Note: Currently only supports contract trading (spot is implemented as 1X contracts), so please ensure your contract account has sufficient balance

### Supported Exchanges
#### Supported Exchanges

| Exchange | Notes | Status |
| --- | --- | --- |
| **Binance** | Only supports international site [binance.com](binance.com), not US site. Uses USDT-M futures (USDT-margined contracts). Ensure your futures account has sufficient USDT balance. Trading pair format: `BTC/USDT` | ✅ Tested |
| **Hyperliquid** | Only supports USDC as margin currency. Uses your main wallet address + API wallet private key authentication (use [API tab](https://app.hyperliquid.xyz/API) to apply). Market orders are automatically converted to IoC limit orders. Trading pair format must be manually adjusted to `SYMBOL/USDC` (e.g., `WIF/USDC`) | ✅ Tested |
| **OKX** | Requires API Key, Secret, and Passphrase for authentication. Supports USDT-margined contracts. Trading pair format: `BTC/USDT` | ✅ Tested |
| **Binance** | Only supports international site [binance.com](binance.com), not US site. Uses USDT-M futures (USDT-margined contracts). Ensure your futures account has sufficient USDT balance. Trading pair format: `BTC/USDT`. Note: Ensure perpetual contract account balance is not 0. When applying for API, add IP whitelist by searching `My IP` in search engine | ✅ Tested |
| **Hyperliquid** | Only supports USDC as margin currency. Uses your main wallet address + API wallet private key authentication (use [API tab](https://app.hyperliquid.xyz/API) to apply). Market orders are automatically converted to IoC limit orders. Trading pair format must be manually adjusted to `SYMBOL/USDC` (e.g., `WIF/USDC`). Configure with main wallet address + API wallet private key. Minimum 10U per trade | ✅ Tested |
| **OKX** | Requires API Key, Secret, and Passphrase (OKX account password) for authentication. Supports USDT-margined contracts. Trading pair format: `BTC/USDT` | ✅ Tested |
| Coinbase | Supports USDT-margined contracts. Coinbase International is not yet supported | 🟡 Partially Tested |
| Gate.io | Supports USDT-margined contracts. Requires API Key and Secret | 🟡 Partially Tested |
| MEXC | Supports USDT-margined contracts. Requires API Key and Secret | 🟡 Partially Tested |
Expand All @@ -188,26 +124,64 @@ Once the application is running, you can explore the web interface to interact w
- To ensure your account safety, you need to reset your API keys regularly.

---

**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 local data stores and start fresh:
- LanceDB directory (stored in your system application directory):
- LanceDB directory (stored in your system application directory, same path as `.env`):
- macOS: `~/Library/Application Support/ValueCell/lancedb`
- Linux: `~/.config/valuecell/lancedb`
- Windows: `%APPDATA%\ValueCell\lancedb`
- Knowledge directory (stored in your system application directory):
- Windows: `%APPDATA%\\ValueCell\\lancedb`
- Knowledge directory (stored in your system application directory, same path as `.env`):
- macOS: `~/Library/Application Support/ValueCell/.knowledge`
- Linux: `~/.config/valuecell/.knowledge`
- Windows: `%APPDATA%\ValueCell\.knowledge`
- SQLite database file (stored in your system application directory):
- Windows: `%APPDATA%\\ValueCell\\.knowledge`
- SQLite database file (stored in your system application directory, same path as `.env`):
- macOS: `~/Library/Application Support/ValueCell/valuecell.db`
- Linux: `~/.config/valuecell/valuecell.db`
- Windows: `%APPDATA%\ValueCell\valuecell.db`
- Windows: `%APPDATA%\\ValueCell\\valuecell.db`


# Developers
## Developers

We sincerely invite all developers to join our Discord discussion group, where we regularly share the community roadmap and upcoming contributor benefit plans.

Details on development processes and standards are provided below:[CONTRIBUTING.md](.github/CONTRIBUTING.md)

ValueCell is a Python-based application with a comprehensive web interface, supporting multi-platform deployment. Follow the configuration below to get started quickly.

## Clone Repository

```bash
git clone https://github.com/ValueCell-ai/valuecell.git
cd valuecell
```

## Running the Application

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

### Linux / Macos
```bash
bash start.sh
```

### Windows (PowerShell)
```powershell
.\start.ps1
```

### Accessing the Interface

- **Web UI**: Navigate to [http://localhost:1420](http://localhost:1420) in your browser
- **Logs**: View application logs directly in the terminal for detailed runtime information of backend services and individual agents

### Next Steps

Once the application is running, you can explore the web interface to interact with ValueCell's features and capabilities.

### Configuration

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

# Roadmap

## 🤖 Enhanced Agent Capabilities
Expand Down
Loading