Skip to content

Commit

Permalink
docs: Added images for Usage guidelines of Drifty CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
SaptarshiSarkar12 committed Aug 11, 2024
1 parent 2455ffa commit 7eef297
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
3 changes: 1 addition & 2 deletions Website/app/docs/Usage/drifty-cli/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ Drifty CLI is the command-line interface for Drifty that allows you to download
> [!NOTE]
> We have assumed that the name of the executable for Drifty CLI is `drifty`. Replace `drifty` with the actual executable name if it is different in your case.
[//]: # (TODO: Add image link)
![Drifty CLI Help]()
![Drifty CLI Help](https://github.com/user-attachments/assets/b695f3b4-c695-4dfe-a431-9742671488f9)

## Commands

Expand Down
13 changes: 6 additions & 7 deletions Website/app/docs/Usage/drifty-cli/downloading-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,22 +53,21 @@ Drifty CLI allows you to download files from the internet using a simple command
```bash
drifty --list
```
![List Command]()
![List Command](https://github.com/user-attachments/assets/bc109432-43ef-461a-bc2e-751ce78e87b4)
3. Add URLs to the download queue using the `--add` command.
```bash
drifty --add "https://download.oracle.com/java/22/latest/jdk-22_linux-x64_bin.tar.gz" "https://www.youtube.com/watch?v=pBy1zgt0XPc"
```
![Add Command]()
![Add Command](https://github.com/user-attachments/assets/5043cfe3-adcf-45a1-aead-33f3dec8a8cd)
4. You can view the URLs just added to the queue by using the `--list` command.
```bash
drifty --list
```
![List Command]()
![List Command](https://github.com/user-attachments/assets/b675b9e2-2159-4125-8996-535ba03f6cfe)
5. Start downloading the URLs in the download queue using the `--get` command.
```bash
drifty --get
```
![Get Command]()
6. The files will be downloaded sequentially to the default download directory as we have not specified a custom download location.
7. After the download is complete, you will be prompted to download another file or exit the application. Enter `Q` to exit or any other key to continue downloading files.
![Exit Prompt]()
![Get Command](https://github.com/user-attachments/assets/0481a556-fea1-4d4f-9383-8e1d842ee388)
6. The files will be downloaded sequentially to the default download directory. After the download is complete, Drifty CLI will automatically remove the URLs from the queue and exit.
![Queue Download Done](https://github.com/user-attachments/assets/6ecea884-9587-4a7a-9a62-8b3052ac3a1d)

0 comments on commit 7eef297

Please sign in to comment.