Skip to content

Commit ab77ccc

Browse files
authored
docs: Add detailed uv installation guide in README files (#148)
1 parent 7b8c6a0 commit ab77ccc

3 files changed

Lines changed: 69 additions & 9 deletions

File tree

README.ja.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,15 +81,35 @@ openderisk-server
8181

8282
### ソースからのインストール(開発用)
8383

84-
uv のインストール(必須):
84+
#### uv のインストール(必須)
85+
86+
**macOS/Linux:**
8587
```shell
88+
curl -LsSf https://astral.sh/uv/install.sh | sh
89+
```
8690

91+
**Windows:**
92+
```shell
93+
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
94+
```
95+
96+
#### クローンと依存関係のインストール
97+
98+
```shell
8799
git clone https://github.com/derisk-ai/OpenDerisk.git
88100

89101
cd OpenDerisk
90102

91-
# 依存関係のインストール
92-
sh scripts/prepare_release.sh
103+
# uv で依存関係をインストール
104+
uv sync --all-packages --frozen \
105+
--extra "base" \
106+
--extra "proxy_openai" \
107+
--extra "rag" \
108+
--extra "storage_chromadb" \
109+
--extra "derisks" \
110+
--extra "storage_oss2" \
111+
--extra "client" \
112+
--extra "ext_base"
93113
```
94114

95115
#### サーバーの起動

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,35 @@ openderisk-server
7979

8080
### From source(development)
8181

82-
Install uv (required):
82+
#### Install uv (required)
83+
84+
**macOS/Linux:**
8385
```shell
86+
curl -LsSf https://astral.sh/uv/install.sh | sh
87+
```
8488

89+
**Windows:**
90+
```shell
91+
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
92+
```
93+
94+
#### Clone and Install Dependencies
95+
96+
```shell
8597
git clone https://github.com/derisk-ai/OpenDerisk.git
8698

8799
cd OpenDerisk
88100

89-
# Install Dependencies
90-
sh scripts/prepare_release.sh
101+
# Install Dependencies with uv
102+
uv sync --all-packages --frozen \
103+
--extra "base" \
104+
--extra "proxy_openai" \
105+
--extra "rag" \
106+
--extra "storage_chromadb" \
107+
--extra "derisks" \
108+
--extra "storage_oss2" \
109+
--extra "client" \
110+
--extra "ext_base"
91111
```
92112

93113
#### Start Server

README.zh.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,35 @@ openderisk-server
7979

8080
### 从源码安装(开发环境)
8181

82-
安装 uv(必需):
82+
#### 安装 uv(必需)
83+
84+
**macOS/Linux:**
8385
```shell
86+
curl -LsSf https://astral.sh/uv/install.sh | sh
87+
```
8488

89+
**Windows:**
90+
```shell
91+
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
92+
```
93+
94+
#### 克隆项目并安装依赖
95+
96+
```shell
8597
git clone https://github.com/derisk-ai/OpenDerisk.git
8698

8799
cd OpenDerisk
88100

89-
# 安装依赖
90-
sh scripts/prepare_release.sh
101+
# 使用 uv 安装依赖
102+
uv sync --all-packages --frozen \
103+
--extra "base" \
104+
--extra "proxy_openai" \
105+
--extra "rag" \
106+
--extra "storage_chromadb" \
107+
--extra "derisks" \
108+
--extra "storage_oss2" \
109+
--extra "client" \
110+
--extra "ext_base"
91111
```
92112

93113
#### 启动服务

0 commit comments

Comments
 (0)