Skip to content

Commit 15ab598

Browse files
Update CLI flag from '--mode' to '--practice-mode'
Replaced all occurrences of '--mode' with '--practice-mode' in the documentation for consistency and clarity. This update ensures better alignment with the intended functionality and improves usability.
1 parent 215f6a5 commit 15ab598

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Squidleet offers multiple modes and configuration options for practicing LeetCod
5454
Daily Challenge Mode allows you to fetch and solve the LeetCode Daily Challenge directly from the terminal.
5555

5656
```bash
57-
python3 main.py --mode daily
57+
python3 main.py --practice-mode daily
5858
```
5959

6060
Optional arguments:
@@ -81,7 +81,7 @@ Selected 📅 Daily Challenge Mode
8181
Solve a randomly selected LeetCode problem based on difficulty. Random Practice Mode allows you to solve a randomly selected LeetCode problem. Enhanced difficulty classification includes options such as `easy`, `medium`, `hard`, or a combination (e.g., `--difficulty easy,medium`).
8282

8383
```bash
84-
python3 main.py --mode random --difficulty medium
84+
python3 main.py --practice-mode random --difficulty medium
8585
```
8686

8787
Optional arguments:
@@ -107,7 +107,7 @@ Selected 🎲 Random Problem Mode
107107
Custom Modes enable solving specific problems or sets of problems by providing one or multiple problem slugs (e.g., `--problems two-sum,three-sum`).
108108

109109
```bash
110-
python3 main.py --mode custom --problems two-sum
110+
python3 main.py --practice-mode custom --problems two-sum
111111
```
112112

113113
Optional arguments:
@@ -132,7 +132,7 @@ Selected 🧩 Custom Practice Mode
132132
Study Plan Mode allows you to fetch random problems based on a specific study plan. You can specify the study plan name to fetch problems from that plan.
133133

134134
```bash
135-
python3 main.py --mode study-plan --plan-name top-interview-150
135+
python3 main.py --practice-mode study-plan --plan-name top-interview-150
136136
```
137137

138138
Optional arguments:
@@ -212,7 +212,7 @@ Squidleet exposes two environment variables for logging:
212212
These can also be set via arguments in the CLI:
213213

214214
```bash
215-
python3 main.py --mode daily --log-level INFO --show-detailed-logs
215+
python3 main.py --practice-mode daily --log-level INFO --show-detailed-logs
216216
```
217217

218218
## 🐳 Docker
@@ -241,7 +241,7 @@ docker run --rm -it --env-file .env squidleet
241241

242242
To specify additional options (e.g., modes), append them to the run command:
243243
```bash
244-
docker run --rm -it --env-file .env squidleet --mode daily
244+
docker run --rm -it --env-file .env squidleet --practice-mode daily
245245
```
246246

247247
### Using Docker Compose
@@ -257,7 +257,7 @@ services:
257257
- LEETCODE_SESSION=<your_session_cookie>
258258
stdin_open: true
259259
tty: true
260-
command: ["--mode", "daily"]
260+
command: ["--practice-mode", "daily"]
261261
```
262262
263263
To run the container:

0 commit comments

Comments
 (0)