You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+31-78Lines changed: 31 additions & 78 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9
9
10
10
### Added
11
11
- Planned:
12
-
-**Plan / Code modes** in interactive CLI (explicit “planning” vs “coding” flows for complex tasks).
12
+
-**Plan / Code modes** in interactive CLI (explicit "planning" vs "coding" flows for complex tasks).
13
13
- First‑class support for **open‑source models via third‑party providers** (e.g. OpenRouter, Groq and similar gateways), alongside existing Ollama + cloud integrations.
14
14
15
15
### Changed
@@ -20,87 +20,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
20
20
21
21
---
22
22
23
-
## [0.1.0] - 2025-11-26
23
+
## [0.1.1] - 2025-11-27
24
+
25
+
### Added
26
+
-**UV Support**: Full support for `uv` as an alternative to `python -m venv` for creating virtual environments. Documentation updated to recommend `uv` as the primary method.
27
+
-**Performance Toggles**: New `/fast-mode [on|off]`, `/disable-rag`, and `/enable-rag` commands for controlling RAG indexing and response speed. Performance settings now visible in welcome screen and `/status` command.
28
+
-**Venv Detection**: Automatic detection of virtual environment in project root with startup warnings if missing.
29
+
30
+
### Changed
31
+
- Welcome screen now displays RAG Mode and Fast Mode status with context-aware tips.
32
+
- Code execution prefers Python from project's `.venv/bin/python` when available.
33
+
- Documentation updated to recommend `uv` as the primary installation method.
34
+
35
+
---
24
36
25
-
### Overview
26
-
-**First public release** of DSPy Code: an AI-powered, interactive development and optimization assistant for DSPy (think "Claude Code for DSPy").
37
+
## [0.1.0] - 2025-11-26
27
38
28
39
### Added
29
-
-**Interactive CLI & Workflows**
30
-
- Rich TUI with animated thinking indicators, status panels, and history-aware prompts.
31
-
- Fully conversational flow: describe what you want in natural language, get DSPy code, ask follow‑ups.
-**Interactive CLI**: Rich TUI with natural language interface for generating DSPy Signatures, Modules, and Programs. Core workflows: development (`/init` → generate → `/validate` → `/run`) and optimization (`/data` → `/optimize` → `/eval`).
41
+
-**Model Support**: Local Ollama models and cloud providers (OpenAI, Anthropic, Gemini) with interactive `/model` command for easy connection. SDK support via optional extras: `dspy-code[openai]`, `dspy-code[anthropic]`, `dspy-code[gemini]`, `dspy-code[llm-all]`.
42
+
-**Code Generation**: Natural language to DSPy code with support for major patterns (ChainOfThought, ReAct, RAG, etc.) and templates for common use cases.
43
+
-**Validation & Execution**: `/validate` for code checks, `/run` and `/test` for sandboxed execution.
44
+
-**GEPA Optimization**: End-to-end optimization workflows with `/optimize` commands and evaluation metrics integration.
45
+
-**MCP Integration**: Built-in MCP client for connecting to external tools and data sources.
-**Documentation**: Complete docs site (MkDocs Material) with getting started guides, tutorials, and reference documentation.
87
48
88
49
### Changed
89
-
- Default Ollama generation timeout increased to 120 seconds to better support large models.
90
-
- Examples across README and docs updated to use modern models (e.g. `gpt-5-nano`, `claude-sonnet-4.5`, `gemini-2.5-flash`, `gpt-oss:120b`) and to recommend `/model` as the primary way to connect.
91
-
- Quick Start and model‑connection docs now make model connection mandatory and show clear virtual‑env + provider‑SDK installation flows using `dspy-code[...]` extras and `uv`/`pip`.
92
-
- Interactive UI improved with modern Rich versions and a `DSPY_CODE_SIMPLE_UI` mode for environments with limited emoji/spinner support.
93
-
- Natural language intent routing in interactive mode refined to:
94
-
- Prefer natural‑language answers for questions.
95
-
- Avoid double code generation and incorrect `/explain` follow‑ups.
96
-
- MkDocs navigation configuration tuned (tabs, sections) to keep the left nav stable and highlight the active page correctly.
50
+
- Default Ollama timeout increased to 120 seconds for large models.
51
+
- Examples updated to use modern models (`gpt-5-nano`, `claude-sonnet-4.5`, `gemini-2.5-flash`).
52
+
- Interactive UI improved with Rich library and `DSPY_CODE_SIMPLE_UI` mode for limited emoji support.
53
+
- Natural language routing refined to prefer answers for questions and avoid duplicate code generation.
97
54
98
55
### Fixed
99
-
- OpenAI deprecation issues (`APIRemovedInV1`) by migrating from `ChatCompletion` to the new client API, and removing unsupported `max_tokens`/`temperature` parameters for models like `gpt-5-nano`.
100
-
- Interactive mode errors:
101
-
-`name 'explanations' is not defined` during `/explain`.
102
-
- Syntax errors in `nl_command_router` debug logging.
103
-
- Ollama timeout handling for large models, with clearer error messages on connection/generation failures.
104
-
- Documentation glitches:
105
-
- Stray `\n` in callouts.
106
-
- Navigation behavior that caused pages to disappear or not highlight correctly.
56
+
- OpenAI SDK migration to new client API, removed unsupported parameters for newer models.
57
+
- Interactive mode errors (`name 'explanations' is not defined`, syntax errors).
Copy file name to clipboardExpand all lines: docs/getting-started/installation.md
+60-34Lines changed: 60 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,18 +31,38 @@ cd my-dspy-project
31
31
32
32
### Step 2: Create Virtual Environment IN This Directory
33
33
34
-
```bash
35
-
# Create .venv INSIDE your project directory (not elsewhere!)
36
-
python -m venv .venv
34
+
=== "uv (Recommended)"
37
35
38
-
# Activate it
39
-
# For bash/zsh (macOS/Linux):
40
-
source .venv/bin/activate
41
-
# For fish shell:
42
-
source .venv/bin/activate.fish
43
-
# On Windows:
44
-
.venv\Scripts\activate
45
-
```
36
+
```bash
37
+
# Create .venv INSIDE your project directory (not elsewhere!)
38
+
uv venv
39
+
40
+
# Activate it
41
+
# For bash/zsh (macOS/Linux):
42
+
source .venv/bin/activate
43
+
# For fish shell:
44
+
source .venv/bin/activate.fish
45
+
# On Windows:
46
+
.venv\Scripts\activate
47
+
```
48
+
49
+
=== "python -m venv"
50
+
51
+
```bash
52
+
# Create .venv INSIDE your project directory (not elsewhere!)
53
+
python -m venv .venv
54
+
55
+
# Activate it
56
+
# For bash/zsh (macOS/Linux):
57
+
source .venv/bin/activate
58
+
# For fish shell:
59
+
source .venv/bin/activate.fish
60
+
# On Windows:
61
+
.venv\Scripts\activate
62
+
```
63
+
64
+
!!! tip "Why uv?"
65
+
`uv` is a fast Python package manager written in Rust. It's 10-100x faster than pip and provides better dependency resolution. [Learn more about uv](https://docs.astral.sh/uv/)
46
66
47
67
!!! success "Why .venv in the Project?"
48
68
When you create the virtual environment inside your project:
# If you use uv, you can install dspy-code like this
69
82
uv pip install --upgrade dspy-code
70
83
71
84
# Or add it to your project dependencies (pyproject.toml) in one step
72
85
uv add dspy-code
73
86
```
74
87
88
+
=== "pip"
89
+
90
+
```bash
91
+
# This installs into .venv/ in your project
92
+
pip install --upgrade dspy-code
93
+
```
94
+
75
95
That's it! DSPy Code is now installed in your project.
76
96
77
97
### Step 4: Install DSPy (Optional)
78
98
79
99
DSPy Code will install DSPy automatically if needed, but you can install/upgrade it explicitly:
80
100
81
-
=== "pip"
101
+
!!! tip "Use the same tool you used for venv"
102
+
If you created your venv with `uv venv`, use `uv pip install` for consistency. If you used `python -m venv`, use `pip install`.
103
+
104
+
=== "uv (Recommended)"
82
105
83
106
```bash
84
-
pip install --upgrade dspy
107
+
uv pip install --upgrade dspy
85
108
```
86
109
87
-
=== "uv"
110
+
=== "pip"
88
111
89
112
```bash
90
-
uv pip install --upgrade dspy
113
+
pip install --upgrade dspy
91
114
```
92
115
93
116
!!! info "DSPy Version"
@@ -156,38 +179,41 @@ DSPy Code has optional dependencies for different features. Install only what yo
156
179
157
180
### Cloud Model Providers (via dspy-code extras)
158
181
159
-
Use extras so versions stay aligned with dspy-code’s tested matrix.
182
+
Use extras so versions stay aligned with dspy-code's tested matrix.
160
183
161
-
=== "pip"
184
+
!!! tip "Use the same tool you used for venv"
185
+
If you created your venv with `uv venv`, use `uv pip install` for consistency. If you used `python -m venv`, use `pip install`.
186
+
187
+
=== "uv (Recommended)"
162
188
163
189
```bash
164
190
# OpenAI support
165
-
pip install "dspy-code[openai]"
191
+
uv pip install "dspy-code[openai]"
166
192
167
193
# Google Gemini support
168
-
pip install "dspy-code[gemini]"
194
+
uv pip install "dspy-code[gemini]"
169
195
170
196
# Anthropic (paid key required)
171
-
pip install "dspy-code[anthropic]"
197
+
uv pip install "dspy-code[anthropic]"
172
198
173
199
# Or install all cloud providers at once
174
-
pip install "dspy-code[llm-all]"
200
+
uv pip install "dspy-code[llm-all]"
175
201
```
176
202
177
-
=== "uv"
203
+
=== "pip"
178
204
179
205
```bash
180
206
# OpenAI support
181
-
uv pip install "dspy-code[openai]"
207
+
pip install "dspy-code[openai]"
182
208
183
209
# Google Gemini support
184
-
uv pip install "dspy-code[gemini]"
210
+
pip install "dspy-code[gemini]"
185
211
186
212
# Anthropic (paid key required)
187
-
uv pip install "dspy-code[anthropic]"
213
+
pip install "dspy-code[anthropic]"
188
214
189
215
# Or install all cloud providers at once
190
-
uv pip install "dspy-code[llm-all]"
216
+
pip install "dspy-code[llm-all]"
191
217
```
192
218
193
219
> **Note:** Anthropic has discontinued free API keys. DSPy Code fully supports Claude **if you already have a paid API key**, but Anthropic integration will simply not work without one.
0 commit comments