Update README.md

antoninoLorenzo · Jul 16, 2024 · 9cc518f · 9cc518f
1 parent 9ab8618
commit 9cc518f
Showing 1 changed file with 41 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -99,20 +99,42 @@
   python ai-ops-cli.py --api AGENT_API_ADDRESS
   ```
 
-## 📝Usage
+## 📝 Usage
 
-### Components
-![Deployment Diagram](static/images/deployment_diagram.svg)
+After deploying the Large Language Model (LLM) with Ollama and the AI Agent API, you can access the API using **ai-ops-cli.py**. 
+If you have deployed the AI Agent API using Docker on a specific machine (e.g., an old laptop), you can specify the Agent API endpoint with the `--api` option.
 
-| Component                                  | Description                                                             |
-|--------------------------------------------|-------------------------------------------------------------------------|
-| Frontend                                   | Web interface for the AI Agent built in `React`                         |
-| AI Agent                                   | The implementation of the AI Agent exposed to `Frontend` with `FastAPI` |
-| [Qdrant](https://github.com/qdrant/qdrant) | Vector Database                                                         |
-| [Ollama](https://github.com/ollama/ollama) | LLM Provider                                                            | 
+To view the available options and commands, run `python ai-ops-cli.py -h`:
+```
+usage: ai-ops-cli.py [-h] [--api API]        
+                                             
+options:                                     
+  -h, --help  show this help message and exit
+  --api API   The Agent API address      
+```
+
+### Commands
+
+Once the CLI is running, you can interact with the agent using the following commands:
 
+#### Basic Commands
+- `help`   : Display a list of available commands.
+- `bye`    : Exit the program.
 
-### Supported Ollama Models
+#### Agent Related Commands
+- `chat`   : Open a chat session with the agent.
+- `-1`     : Exit the chat session.
+- `exec`   : Execute the last plan generated by the agent.
+- `plans`  : List all plans created in the current session.
+
+#### Session Related Commands
+- `new`    : Create a new session.
+- `save`   : Save the current session.
+- `delete` : Delete a saved session from the persistent storage.
+- `list`   : Display all saved sessions.
+- `load`   : Load a saved session.```
+
+### Supported Models
 | Name         | Implemented (prompts) |
 |--------------|----------------------|
 | **Gemma 7B** | &check;              |
@@ -121,6 +143,15 @@
 
 <!--| **LLama 3**  | &cross;               | -->
 
+### Components
+![Deployment Diagram](static/images/deployment_diagram.svg)
+
+| Component                                  | Description                                                             |
+|--------------------------------------------|-------------------------------------------------------------------------|
+| Frontend                                   | Web interface for the AI Agent built in `React`                         |
+| AI Agent                                   | The implementation of the AI Agent exposed to `Frontend` with `FastAPI` |
+| [Qdrant](https://github.com/qdrant/qdrant) | Vector Database                                                         |
+| [Ollama](https://github.com/ollama/ollama) | LLM Provider                                                            | 
 
 
 ## 🛠️Tools