Skip to content

Commit

Permalink
Update UG with CLI and how to guide
Browse files Browse the repository at this point in the history
  • Loading branch information
officialchengyud committed Apr 13, 2024
1 parent 94f08da commit 7001e61
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@ the command-line interface (CLI).]

### How to use the command line interface (CLI)

MediCLI is operated using typed commands to the command line interface (CLI). Do not worry if you do not understand CLI yet; Here we will explain to you the formats of text commands and how to use them.

![Ui](images/cli_format.png)

| CLI Format | What it means |
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Command | The command tells MediCLI what action you want to perform. |
| Index | Certain MediCLI commands have an `INDEX` field, which is a number that is assigned to a particular patient, doctor or appointment. Index must be larger than 1 and can be up to the maximum number of patients/doctors or appointments as listed in the MediCLI GUI. |
| Parameter Prefix | Fields typically have a prefix like `i/` or `n/` followed by the field content. This tells MediCLI what field you are entering. |
| Command Parameter | The command parameter is the parameter prefix followed by field content. For example, the command parameter to enter NRIC would be `i/S1234567A` |

<div markdown="span" class="alert alert-info">:information_source: **INFO**: Not all MediCLI commands have fields! For example, the command to clear all data is simply `clear`.</div>

### Initial start-up and sample use-case

1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
Expand Down
Binary file added docs/images/cli_format.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7001e61

Please sign in to comment.