Skip to content

Commit 24a9746

Browse files
committed
updated usage instructions
1 parent b77fa2f commit 24a9746

File tree

2 files changed

+39
-16
lines changed

2 files changed

+39
-16
lines changed

README.md

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,39 @@ Executes leetcode testcases and submits your solution through CLI interface
88

99
## Installation
1010

11+
### Using pre-built binaries
12+
13+
1. Go to the [Releases section](/releases) and download the appropriate binary for your system.
14+
15+
1. Place the binary in appropriate location and add the location in your PATH environment variable.
16+
17+
### Building from source
18+
1119
1. Install [rust from here](https://www.rust-lang.org/tools/install) to compile the source code.
1220

13-
1. Clone the repository and install the binary.
21+
1. Clone the repository and move to the repository directory.
1422

1523
```bash
1624
git clone https://github.com/dvishal485/leetcode-runner-cli.git
1725
cd leetcode-runner-cli
26+
```
27+
28+
1. Compile and install the binary.
29+
30+
```bash
1831
cargo install --path .
1932
```
2033

34+
#### Note
35+
36+
Depending on your platform you may need to install certain tools to be able to compile successfully.
37+
38+
For example: On Ubuntu system, you may need to execute `apt-get install pkg-config openssl-dev -y` to be able to compile the program successfully.
39+
40+
---
41+
42+
## Usage
43+
2144
1. Setup environment variable `LC_COOKIE` with your leetcode session cookie.
2245

2346
You can get your session cookie by logging in to leetcode and inspecting the cookie in your browser's developer tools.
@@ -36,26 +59,25 @@ Executes leetcode testcases and submits your solution through CLI interface
3659
3760
---
3861
39-
## Usage
4062
4163
```bash
42-
leetcode-runner-cli [FLAGS] [OPTIONS <option>]
64+
leetcode-runner-cli [COMMAND] [OPTIONS <option>]
4365
```
4466
4567
### Commands
4668
47-
| Commands | Description | Arguments |
48-
| :----------------- | :-------------------------------------------------- | :---------------------------- |
49-
| `-h, --help` | Prints help information | - |
50-
| `-V, --version` | Prints version information | - |
51-
| `-a, auth` | Authenticate with leetcode | - |
52-
| `-d, daily` | Fetch daily challenge question | - |
53-
| `-q, question` | Question title / url to fetch | [question_title] |
54-
| `-r, run` | Execute file with default testcases | [file_to_run] |
55-
| `-rt, run-custom` | Execute file with custom testcases | [testcase_file] [file_to_run] |
56-
| `-s, submit` | Submit solution to leetcode after passing testcases | [file_to_submit] |
57-
| `-fs, fast-submit` | Submit solution to leetcode | [file_to_submit] |
58-
| `-p, pack` | Pack your solution and question in a directory | [file_to_consider] |
69+
| Commands | Description | Arguments |
70+
| :----------------- | :-------------------------------------------------- | :------------------------------ |
71+
| `-h, --help` | Prints help information | - |
72+
| `-V, --version` | Prints version information | - |
73+
| `-a, auth` | Authenticate with leetcode | - |
74+
| `-d, daily` | Fetch daily challenge question | - |
75+
| `-q, question` | Question title / url to fetch | <QUESTION_NAME> |
76+
| `-r, run` | Execute file with default testcases | -f <FILE> (optional) |
77+
| `-rt, run-custom` | Execute file with custom testcases | -f <FILE> (optional) <TESTCASE> |
78+
| `-s, submit` | Submit solution to leetcode after passing testcases | -f <FILE> (optional) |
79+
| `-fs, fast-submit` | Submit solution to leetcode | -f <FILE> (optional) |
80+
| `-p, pack` | Pack your solution and question in a directory | -f <FILE> (optional) |
5981
6082
### File changes
6183
@@ -166,4 +188,4 @@ More languages can be added manually as per requirement by [changing enum](https
166188
- This Project is [Apache-2.0](./LICENSE) Licensed
167189
- Copyright 2023 [Vishal Das](https://github.com/dvishal485)
168190
169-
---
191+
--

src/args.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ pub enum Commands {
5555
/// Packs the solution with the question into a directory
5656
#[command(visible_alias = "-p")]
5757
Pack {
58+
#[arg(short, long)]
5859
/// File to pack
5960
file: Option<PathBuf>,
6061
},

0 commit comments

Comments
 (0)