Update CLI documentation

serraict · Oct 14, 2024 · 90ed1da · 90ed1da
1 parent 7375319
commit 90ed1da
Showing 1 changed file with 13 additions and 6 deletions.
diff --git a/docs/cli_documentation.md b/docs/cli_documentation.md
@@ -12,10 +12,10 @@
 │ --help                        Show this message and exit.                                                                                            │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
-│ about                                                                                                                                                │
-│ db                                                                                                                                                   │
-│ inventory                                                                                                                                            │
-│ sync                                                                                                                                                 │
+│ about       Display information about the Floriday Vine command line interface.                                                                      │
+│ db          Database management commands.                                                                                                            │
+│ inventory   Inventory management commands.                                                                                                           │
+│ sync        Synchronize collections in the local database with Floriday.                                                                             │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 
 ```
@@ -26,6 +26,8 @@
                                                                                                                                                         
  Usage: floridayvine about [OPTIONS] COMMAND [ARGS]...                                                                                                  
                                                                                                                                                         
+ Display information about the Floriday Vine command line interface.                                                                                    
+                                                                                                                                                        
 ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ --help          Show this message and exit.                                                                                                          │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -42,6 +44,8 @@
                                                                                                                                                         
  Usage: floridayvine db [OPTIONS] COMMAND [ARGS]...                                                                                                     
                                                                                                                                                         
+ Database management commands.                                                                                                                          
+                                                                                                                                                        
 ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ --help          Show this message and exit.                                                                                                          │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -57,13 +61,14 @@
                                                                                                                                                         
  Usage: floridayvine inventory [OPTIONS] COMMAND [ARGS]...                                                                                              
                                                                                                                                                         
+ Inventory management commands.                                                                                                                         
+                                                                                                                                                        
 ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ --help          Show this message and exit.                                                                                                          │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ list-direct-sales   List all direct sales from Floriday.                                                                                             │
 │ list-trade-items    List all trade items from Floriday.                                                                                              │
-│ sync                                                                                                                                                 │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 
 ```
@@ -74,12 +79,14 @@
                                                                                                                                                         
  Usage: floridayvine sync [OPTIONS] COMMAND [ARGS]...                                                                                                   
                                                                                                                                                         
+ Synchronize collections in the local database with Floriday.                                                                                           
+                                                                                                                                                        
 ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ --help          Show this message and exit.                                                                                                          │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ organizations   Synchronize organizations data from Floriday.                                                                                        │
-│ status                                                                                                                                               │
+│ status          Display the synchronization status for all synchronized collections.                                                                 │
 │ trade-items     Synchronize trade items data from Floriday.                                                                                          │
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯