Skip to content

Commit 1ba81a2

Browse files
valorisaclaude
andcommitted
Refactor: Comprehensive README improvements and new troubleshooting section
Major changes: - Add new "Vérifications et Dépannage Rapide" section (section 10) - Fix incorrect proxy restart command (uv run uvicorn instead of python server.py) - Move troubleshooting paragraph from Linux section to dedicated section Editorial improvements: - Fix typo in MIT badge: "yelow" → "yellow" - Remove 4 duplicate sentences/phrases throughout document - Consolidate repetitive text for better readability Technical corrections: - Add `sleep 3` to single-terminal method for consistency - Clarify `server:app` notation as "module:variable" format - Update table of contents with new section numbering Statistics: - 7 major corrections applied - 1 new section added - 4 repetitions eliminated - 1 critical typo fixed - 1 incorrect command replaced Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 160e968 commit 1ba81a2

1 file changed

Lines changed: 53 additions & 45 deletions

File tree

README.md

Lines changed: 53 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[![CI](https://github.com/valorisa/Free-Claude-Code-Guide/actions/workflows/ci.yml/badge.svg)](https://github.com/valorisa/Free-Claude-Code-Guide/actions/workflows/ci.yml)
55
[![Lint](https://github.com/valorisa/Free-Claude-Code-Guide/actions/workflows/lint.yml/badge.svg)](https://github.com/valorisa/Free-Claude-Code-Guide/actions/workflows/lint.yml)
6-
[![License: MIT](https://img.shields.io/badge/License-MIT-yelow.svg)](https://opensource.org/licenses/MIT)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77
[![GitHub stars](https://img.shields.io/github/stars/valorisa/Free-Claude-Code-Guide?style=social)](https://github.com/valorisa/Free-Claude-Code-Guide)
88
[![GitHub forks](https://img.shields.io/github/forks/valorisa/Free-Claude-Code-Guide?style=social)](https://github.com/valorisa/Free-Claude-Code-Guide/network/members)
99
[![GitHub watchers](https://img.shields.io/github/watchers/valorisa/Free-Claude-Code-Guide?style=social)](https://github.com/valorisa/Free-Claude-Code-Guide/watchers)
@@ -25,10 +25,11 @@
2525
7. [Comprendre le Routage des Modèles](#comprendre-le-routage-des-modèles)
2626
8. [Intégration VSCode](#intégration-vscode)
2727
9. [Utilisation Quotidienne](#utilisation-quotidienne)
28-
10. [Dépannage et Subtilités](#dépannage-et-subtilités)
29-
11. [Résumé des Commandes Essentielles](#résumé-des-commandes-essentielles)
30-
12. [Ressources et Liens](#ressources-et-liens)
31-
13. [Avertissements et Bonnes Pratiques](#avertissements-et-bonnes-pratiques)
28+
10. [Vérifications et Dépannage Rapide](#vérifications-et-dépannage-rapide)
29+
11. [Dépannage et Subtilités](#dépannage-et-subtilités)
30+
12. [Résumé des Commandes Essentielles](#résumé-des-commandes-essentielles)
31+
13. [Ressources et Liens](#ressources-et-liens)
32+
14. [Avertissements et Bonnes Pratiques](#avertissements-et-bonnes-pratiques)
3233

3334
---
3435

@@ -187,43 +188,12 @@ cd ~/Projets/free-claude-code && uv run uvicorn server:app --host 0.0.0.0 --port
187188

188189
- L'intégration VSCode fonctionne de la même manière que sur macOS
189190

190-
> **💡 Note importante pour le test** : Vous n'avez **pas besoin** d'être dans un dossier spécifique comme `$HOME/Projets/free-claude-code-guide` ou `$HOME/Projets/free-claude-code`. Vous pouvez lancer Claude Code depuis **n'importe quel dossier**.
191-
>
192-
> **Ce qu'il faut vérifier** :
193-
>
194-
> 1. **Vérifier que le proxy tourne** (port 8082) :
195-
>
196-
> ```bash
197-
> lsof -i :8082
198-
> ```
199-
>
200-
> S'il ne tourne plus, relancez-le :
201-
>
202-
> ```bash
203-
> cd $HOME/Projets/free-claude-code && source .venv/bin/activate && python server.py --port 8082 &
204-
> ```
205-
>
206-
> 2. **Lancer Claude Code avec les variables** (depuis n'importe où) :
207-
>
208-
> ```bash
209-
> export ANTHROPIC_BASE_URL="http://localhost:8082"
210-
> export ANTHROPIC_AUTH_TOKEN="freecc"
211-
> claude
212-
> ```
213-
>
214-
> Ou en une seule commande :
215-
>
216-
> ```bash
217-
> ANTHROPIC_BASE_URL="http://localhost:8082" ANTHROPIC_AUTH_TOKEN="freecc" claude
218-
> ```
219-
220191
---
221192

222193
## Qu'est-ce que Free Claude Code ?
223194

224195
**Free Claude Code** (dépôt : `Alishahryar1/free-claude-code`) est un **proxy**. Il redirige les appels API d'Anthropic vers des fournisseurs gratuits ou personnels, notamment **NVIDIA NIM**.
225-
C'est un projet open-source. Il est très utilisé. Il est performant.
226-
C'est un projet open-source.
196+
C'est un projet open-source. Il est très utilisé et performant.
227197

228198
### Ce que ça fait :
229199

@@ -273,8 +243,8 @@ NVIDIA_NIM_PROXY=""
273243

274244
#### 2. Le routage Opus/Sonnet/Haiku
275245

276-
Claude Code demande des modèles par "tiers" (Opus = complexe, Sonnet = équilibré, Haiku = rapide). Ces tiers sont **virtuels** dans ce contexte. Ils sont routés vers des vrais modèles :
277-
C'est une particularité du projet. C'est unique.
246+
Claude Code demande des modèles par "tiers" (Opus = complexe, Sonnet = équilibré, Haiku = rapide). Ces tiers sont **virtuels** dans ce contexte. Ils sont routés vers des vrais modèles.
247+
C'est une particularité unique du projet.
278248

279249
- `MODEL_OPUS` → Normalement pour tâches complexes (ex: Kimi K2)
280250
- `MODEL_SONNET` → Équilibré (ex: GLM-4.7)
@@ -303,9 +273,7 @@ $HOME/Projets/free-claude-code-guide
303273

304274
### Étape 1 : Installer uv (gestionnaire de paquets Python moderne)
305275

306-
`uv` est un outil équivalent à `pip` mais beaucoup plus rapide. Il gère aussi les versions de Python. Il est recommandé de l'utiliser pour ce projet. C'est un outil moderne. Il est performant. Il est très rapide.
307-
Il est très performant.
308-
Il est très performant.
276+
`uv` est un outil équivalent à `pip` mais beaucoup plus rapide. Il gère aussi les versions de Python. Il est recommandé de l'utiliser pour ce projet. C'est un outil moderne, performant et très rapide.
309277

310278
```bash
311279
curl -LsSf https://astral.sh/uv/install.sh | sh
@@ -402,8 +370,7 @@ MODEL="nvidia_nim/z-ai/glm4.7"
402370
ANTHROPIC_AUTH_TOKEN="freecc"
403371
```
404372

405-
Ce token est **local** et **fictif**. Claude Code l'envoie au proxy, et le proxy le renvoie tel quel. Vous pouvez mettre n'importe quelle valeur (ex: "toto", "1234"). "freecc" est la convention du projet. C'est un token de test.
406-
C'est un token de test. Il n'est pas sensible.
373+
Ce token est **local** et **fictif**. Claude Code l'envoie au proxy, et le proxy le renvoie tel quel. Vous pouvez mettre n'importe quelle valeur (ex: "toto", "1234"). "freecc" est la convention du projet. C'est un token de test non sensible.
407374

408375
#### 4. Options de "Thinking" (Raisonnement)
409376

@@ -514,7 +481,7 @@ uv run uvicorn server:app --host 0.0.0.0 --port 8082
514481

515482
- `uv run` : Exécute la commande dans l'environnement virtuel du projet
516483
- `uvicorn` : Serveur web ASGI (comme gunicorn mais pour Python asynchrone)
517-
- `server:app` : Le fichier `server.py` et la variable `app` (l'application FastAPI)
484+
- `server:app` : Le fichier `server.py` et la variable `app` (notation Python : module:variable pour l'application FastAPI)
518485
- `--host 0.0.0.0` : Écoute sur toutes les interfaces (pas seulement localhost)
519486
- `--port 8082` : Port d'écoute
520487

@@ -545,6 +512,7 @@ Si vous préférez n'utiliser qu'un seul terminal :
545512
```bash
546513
cd $HOME/Projets/free-claude-code
547514
uv run uvicorn server:app --host 0.0.0.0 --port 8082 &
515+
sleep 3
548516
ANTHROPIC_AUTH_TOKEN="freecc" ANTHROPIC_BASE_URL="http://localhost:8082" claude
549517
```
550518

@@ -564,6 +532,46 @@ pkill -f uvicorn
564532

565533
---
566534

535+
## Vérifications et Dépannage Rapide
536+
537+
### Principe de base
538+
539+
**💡 Point important** : Claude Code peut être lancé depuis **n'importe quel dossier** de votre système. Vous n'avez pas besoin d'être dans `$HOME/Projets/free-claude-code` ou `$HOME/Projets/free-claude-code-guide`.
540+
541+
### Vérifications essentielles
542+
543+
#### 1. Vérifier que le proxy tourne (port 8082)
544+
545+
```bash
546+
lsof -i :8082
547+
```
548+
549+
**Résultat attendu** : Vous devriez voir une ligne avec `uvicorn` et le port `8082`.
550+
551+
**Si aucun résultat** : Le proxy ne tourne pas. Relancez-le :
552+
553+
```bash
554+
cd $HOME/Projets/free-claude-code && uv run uvicorn server:app --host 0.0.0.0 --port 8082 &
555+
```
556+
557+
#### 2. Lancer Claude Code depuis n'importe où
558+
559+
**Option A : Variables temporaires (recommandé)**
560+
561+
```bash
562+
ANTHROPIC_AUTH_TOKEN="freecc" ANTHROPIC_BASE_URL="http://localhost:8082" claude
563+
```
564+
565+
**Option B : Export puis lancement**
566+
567+
```bash
568+
export ANTHROPIC_BASE_URL="http://localhost:8082"
569+
export ANTHROPIC_AUTH_TOKEN="freecc"
570+
claude
571+
```
572+
573+
---
574+
567575
## Dépannage et Subtilités
568576

569577
### Le proxy ne démarre pas

0 commit comments

Comments
 (0)