|
1 | | -### Leetcode CLI |
| 1 | +# LeetCode CLI |
2 | 2 |
|
3 | | -A command-line interface tool for LeetCode that helps you practice coding problems directly from your terminal. This CLI application streamlines the process of accessing, solving, and submitting LeetCode problems without leaving your development environment. |
| 3 | +A sleek command-line tool for LeetCode - solve, test, and submit problems directly from your terminal. |
4 | 4 |
|
5 | | -### Commands |
6 | | -- `lc login` - Login to your LeetCode account |
7 | | -- `lc logout` - Logout from your LeetCode account |
8 | | -- `lc profile` - Show your LeetCode profile |
9 | | -- `lc daily` - Show today's daily challenge |
10 | | -- `lc list` - List all problems |
11 | | -- `lc show` - Show problem details |
12 | | -- `lc test` - Test your solution |
13 | | -- `lc test` - Test your solution |
14 | | -- `lc submit` - Submit your solution |
15 | | -- `lc edit` - Edit your solution |
| 5 | +### Preview |
16 | 6 |
|
17 | | -### Installation |
| 7 | + |
18 | 8 |
|
| 9 | +### 🚀 Quick Start |
| 10 | + |
| 11 | +#### 1. Using pip |
| 12 | +```bash |
| 13 | +pip install leetcode-cli |
| 14 | +``` |
| 15 | + |
| 16 | +#### 2. clone the repository |
19 | 17 | ```bash |
20 | 18 | git clone https://github.com/yuvrajsinh5252/leetcode-cli |
| 19 | +``` |
| 20 | + |
| 21 | +```bash |
21 | 22 | cd leetcode-cli |
22 | 23 | python -m venv .venv |
23 | 24 | source ./.venv/bin/activate |
24 | 25 | pip install -r requirements.txt |
25 | 26 | pip install -e . |
26 | 27 | ``` |
27 | 28 |
|
28 | | -Currently under development. More features and documentation will be added soon. |
| 29 | +### Available Commands |
| 30 | + |
| 31 | +| Command | Description | Options | |
| 32 | +|---------|-------------|----------| |
| 33 | +| `lc login` | Login to LeetCode account | - | |
| 34 | +| `lc logout` | Logout from LeetCode | - | |
| 35 | +| `lc profile` | Display LeetCode profile | - | |
| 36 | +| `lc daily` | Show today's challenge | `{lang}` - Language (optional)<br>`-e EDITOR` - Preferred editor | |
| 37 | +| `lc list` | List all problems | `-d` - Difficulty<br>`-s` - Status<br>`-t` - Tag<br>`-c` - Category | |
| 38 | +| `lc show` | Display problem details | `{Problem Name/Number}` | |
| 39 | +| `lc test` | Test your solution | `{Problem Name/Number} {FILE}` | |
| 40 | +| `lc submit` | Submit your solution | `{Problem Name/Number} {FILE}` | |
| 41 | +| `lc edit` | Edit solution in editor | `{Problem Name/Number} {lang} [-e EDITOR]` | |
| 42 | + |
| 43 | +### Usage Examples |
| 44 | + |
| 45 | +```bash |
| 46 | +lc list -d easy -s attempted -t array |
| 47 | +lc edit 1 py # edit problem 1 in python |
| 48 | +lc test 1 two-sum.py |
| 49 | +lc submit 1 two-sum.py |
| 50 | +``` |
| 51 | +### 🚧 Work in Progress |
| 52 | + |
| 53 | +#### Todo |
| 54 | +- [ ] Implement test case management |
| 55 | +- [ ] Add support for custom test cases |
| 56 | +- [ ] Improve error handling |
| 57 | +- [ ] Add solution templates |
0 commit comments