Skip to content

Commit 25e00fc

Browse files
jimgqyuclaude
andcommitted
docs: simplify README install to git clone + install.sh, default to DeepSeek
- README Quick Start: git clone + ./install.sh --local (remove curl|bash) - install.sh: default LLM provider changed from Anthropic to DeepSeek - install.sh: API key prompt now asks for DEEPSEEK_API_KEY Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 4684b77 commit 25e00fc

2 files changed

Lines changed: 19 additions & 50 deletions

File tree

README.md

Lines changed: 10 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -21,54 +21,23 @@
2121
## Quick Start
2222

2323
```bash
24-
# Prerequisites: Node.js >= 18.0.0 (Node.js >= 22.0.0 recommended), pnpm >= 9.15.0
24+
# Prerequisites: Node.js >= 18.0.0 (>= 22.0.0 recommended)
2525

26-
# Install dependencies
27-
pnpm install
26+
# Clone the repo
27+
git clone https://github.com/AgenticMatrix/Coder-Agent.git
28+
cd Coder-Agent
2829

29-
# Build all packages
30-
pnpm build
30+
# One-click install (builds, links `coder` command globally, sets up config)
31+
./install.sh --local
3132

32-
# Configure your API key
33-
export ANTHROPIC_API_KEY="sk-ant-api03-your-key-here"
33+
# Set your API key (DeepSeek by default)
34+
export DEEPSEEK_API_KEY="sk-your-key-here"
3435

35-
# Or store it in ~/.coder/settings.json
36-
cat > ~/.coder/settings.json << 'EOF'
37-
{
38-
"theme": "dark",
39-
"model_list": [
40-
{
41-
"name": "deepseek/deepseek-v4-pro",
42-
"model": "deepseek-chat",
43-
"base_url": "https://api.deepseek.com/anthropic",
44-
"auth_token_env": "DEEPSEEK_API_KEY",
45-
"provider": "deepseek"
46-
},
47-
{
48-
"name": "anthropic/claude-sonnet-4-6",
49-
"model": "claude-sonnet-4-6",
50-
"base_url": "https://api.anthropic.com/v1",
51-
"auth_token_env": "ANTHROPIC_API_KEY",
52-
"provider": "anthropic"
53-
}
54-
],
55-
"default_model": "deepseek/deepseek-v4-pro"
56-
}
57-
EOF
58-
59-
# Run Coder Agent
60-
node packages/cli/dist/entry.js
61-
62-
# Or install globally
63-
pnpm link --global
36+
# Start coding
6437
coder
6538
```
6639

67-
For a guided setup, run the installer:
68-
69-
```bash
70-
curl -fsSL https://raw.githubusercontent.com/AgenticMatrix/Coder-Agent/main/install.sh | bash
71-
```
40+
> **Note:** The installer defaults to **DeepSeek** as the LLM provider. To use Anthropic or OpenAI, set the corresponding API key and edit `~/.coder/settings.json`.
7241
7342
---
7443

install.sh

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -180,18 +180,18 @@ echo -e "${YELLOW}║ API Key Configuration ║${NC}"
180180
echo -e "${YELLOW}╚══════════════════════════════════════════════════╝${NC}"
181181
echo ""
182182
echo "Coder Agent supports multiple LLM providers:"
183-
echo " - Anthropic (default): ANTHROPIC_API_KEY"
184-
echo " - DeepSeek: DEEPSEEK_API_KEY"
183+
echo " - DeepSeek (default): DEEPSEEK_API_KEY"
184+
echo " - Anthropic: ANTHROPIC_API_KEY"
185185
echo " - OpenAI: OPENAI_API_KEY"
186186
echo ""
187187

188188
# Check if API keys are already set
189-
if [ -n "${ANTHROPIC_API_KEY:-}" ]; then
190-
echo -e "${GREEN}ANTHROPIC_API_KEY is already set${NC}"
189+
if [ -n "${DEEPSEEK_API_KEY:-}" ]; then
190+
echo -e "${GREEN}DEEPSEEK_API_KEY is already set${NC}"
191191
else
192-
echo -e "${YELLOW}⚠️ ANTHROPIC_API_KEY is not set${NC}"
192+
echo -e "${YELLOW}⚠️ DEEPSEEK_API_KEY is not set${NC}"
193193
echo ""
194-
echo "To set it now, enter your Anthropic API key (or press Enter to skip):"
194+
echo "To set it now, enter your DeepSeek API key (or press Enter to skip):"
195195
read -r -p "API Key: " api_key
196196

197197
if [ -n "$api_key" ]; then
@@ -208,17 +208,17 @@ else
208208
if [ -n "$SHELL_CONFIG" ]; then
209209
echo "" >> "$SHELL_CONFIG"
210210
echo "# Coder Agent — API Key" >> "$SHELL_CONFIG"
211-
echo "export ANTHROPIC_API_KEY=${api_key}" >> "$SHELL_CONFIG"
211+
echo "export DEEPSEEK_API_KEY=${api_key}" >> "$SHELL_CONFIG"
212212
echo -e "${GREEN}✅ API key added to ${SHELL_CONFIG}${NC}"
213213
echo ""
214214
echo -e "${YELLOW}Run 'source ${SHELL_CONFIG}' or restart your terminal to apply.${NC}"
215215
else
216216
echo -e "${YELLOW}Could not detect shell config file. Add this to your shell profile:${NC}"
217-
echo " export ANTHROPIC_API_KEY=${api_key}"
217+
echo " export DEEPSEEK_API_KEY=${api_key}"
218218
fi
219219
else
220220
echo "Skipped. You can set it later:"
221-
echo " export ANTHROPIC_API_KEY=your-key-here"
221+
echo " export DEEPSEEK_API_KEY=your-key-here"
222222
fi
223223
fi
224224

0 commit comments

Comments
 (0)