Skip to content

Commit 9398f41

Browse files
committed
docs: add README
1 parent b7a9324 commit 9398f41

1 file changed

Lines changed: 17 additions & 3 deletions

File tree

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,35 @@ Agentic Data Scientist is an open-source framework that uses a sophisticated mul
2222

2323
## Quick Start
2424

25+
### Prerequisites
26+
27+
Before using Agentic Data Scientist, you must have:
28+
29+
1. **Claude Code CLI** installed
30+
```bash
31+
npm install -g @anthropic-ai/claude-code
32+
```
33+
Or visit [Claude Code Quickstart](https://code.claude.com/docs/en/quickstart)
34+
35+
2. **Required API Keys** configured (see Configuration section below)
36+
- OPENROUTER_API_KEY (for planning and review agents)
37+
- ANTHROPIC_API_KEY (for coding agent)
38+
2539
### Installation
2640

2741
```bash
2842
# Install from PyPI
2943
uv tool install agentic-data-scientist
3044

3145
# Or use with uvx (no installation needed)
32-
uvx agentic-data-scientist "your query here"
46+
uvx agentic-data-scientist --mode simple "your query here"
3347
```
3448

3549
### Configuration
3650

37-
**Required API Keys**
51+
**API Keys**
3852

39-
Before using Agentic Data Scientist, you must configure two API keys:
53+
You must configure two API keys:
4054

4155
1. **OpenRouter API Key** (required for planning and review agents):
4256
```bash

0 commit comments

Comments
 (0)