From 7279f782108a9809822915560ce2ca3eccd4d5cb Mon Sep 17 00:00:00 2001
From: David Onuh <davidonuh1@gmail.com>
Date: Mon, 30 Sep 2024 21:58:22 +0100
Subject: [PATCH] Add readme for cli

---
 README.md             |  28 +----------
 ahnlich/cli/README.md | 111 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 113 insertions(+), 26 deletions(-)
 create mode 100644 ahnlich/cli/README.md

diff --git a/README.md b/README.md
index 17992c12..6199ba5f 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,8 @@ create_store(
 - [`ahnlich-client-rs`](ahnlich/client/): Rust client for `ahnlich-db` and `ahnlich-ai` with support for connection pooling.
 - [`ahnlich-client-py`](sdk/ahnlich-client-py/): Python client for `ahnlich-db` and `ahnlich-ai` with support for connection pooling.
 
+- [`ahnlich-cli`](ahnlich/cli/): CLI for querying `ahnlich-db` and `ahnlich-ai`
+
 
 ## Architecture
 
@@ -53,32 +55,6 @@ create_store(
 2. The CLI comes packaged into the docker images.
 
 
-### Ahnlich CLI.
-Ahnlich ships our CLI that can be used to query either AI or DB binaries.
-
-<p align="left"><img src="assets/cli-clear.gif" alt="ahnlich" height="auto"></p>
-
-To run:
-`ahnlich_cli ahnlich --agent .. --host .. --port ...`
-where:
-  - Agent: Binary to connect to (ai or db)
-  - Host: defaults to `127.0.0.1`
-  - port: default is infered from the agent selected. (`AI = 1370`, `DB = 1369`) 
-
-#### Example Commands
-- **DB**
-
-  - Create Store with dimension 2 and indexes author and country
-
-    `CREATESTORE test_store DIMENSION 2 PREDICATES (author, country)`
-  - Set In store
-    `SET (([1.0, 2.1], {name: Haks, category: dev}), ([3.1, 4.8], {name: Deven, category: dev})) in test_store`
-
-  
-  #### Combining commands
-  CLI can process multiple commands at once as long as each command is delimited by `;`
-    
-    `GETKEY ([1.0, 2.0], [3.0, 4.0]) IN test_store;CREATEPREDINDEX (name, category) in test_store`
 
 ## Development
 
diff --git a/ahnlich/cli/README.md b/ahnlich/cli/README.md
new file mode 100644
index 00000000..b9dda99c
--- /dev/null
+++ b/ahnlich/cli/README.md
@@ -0,0 +1,111 @@
+
+# Ahnlich CLI Documentation
+
+The Ahnlich CLI enables users to query AI and DB binaries using a custom Domain-Specific Language (DSL). This document provides usage instructions, commands, and examples to help you integrate the CLI with your projects.
+
+![Ahnlich CLI](../../assets/cli-clear.gif)
+
+## Installation
+
+To install the Ahnlich CLI, follow these steps:
+```bash
+# Download the binary from github releases
+```
+
+## Running the CLI
+
+To run the Ahnlich CLI, use the following command format:
+```bash
+ahnlich-cli ahnlich --agent <agent> --host <host> --port <port>
+```
+- **Agent**: Binary to connect to (either `ai` or `db`)
+- **Host**: Defaults to `127.0.0.1`
+- **Port**: Defaults based on the selected agent. (`AI = 1370`, `DB = 1369`)
+
+### Example Usage
+
+#### Connect to DB Agent
+```bash
+ahnlich_cli ahnlich --agent db --host 127.0.0.1 --port 1369
+```
+
+#### Connect to AI Agent
+```bash
+ahnlich_cli ahnlich --agent ai --host 127.0.0.1 --port 1370
+```
+
+## Querying the DB
+
+The CLI accepts a range of commands for database operations. Commands are written in the following format:
+
+```bash
+<COMMAND> <ARGS> IN <STORE>
+```
+
+### Example DB Commands
+
+1. **Create a Store**  
+   ```bash
+   CREATESTORE test_store DIMENSION 2 PREDICATES (author, country)
+   ```
+
+2. **Insert Data into a Store**  
+   ```bash
+   SET (([1.0, 2.1], {name: Haks, category: dev}), ([3.1, 4.8], {name: Deven, category: dev})) in test_store
+   ```
+
+3. **Retrieve Data from a Store**  
+   ```bash
+   GETKEY ([1.0, 2.0], [3.0, 4.0]) IN test_store
+   ```
+
+### Combining Multiple Commands
+
+You can combine commands using a semicolon `;` delimiter:
+
+```bash
+GETKEY ([1.0, 2.0], [3.0, 4.0]) IN test_store; CREATEPREDINDEX (name, category) in test_store
+```
+
+### List of Supported DB Commands
+
+- `PING`
+- `LISTCLIENTS`
+- `LISTSTORES`
+- `INFOSERVER`
+- `DROPSTORE store_name IF EXISTS`
+- `CREATEPREDINDEX (key_1, key_2) in store_name`
+- `GETSIMN 4 WITH [vector] USING cosinesimilarity IN store_name WHERE (predicate)`
+- And more...
+
+## Querying AI Binaries
+
+The CLI also supports AI binary queries.
+
+### Example AI Commands
+
+1. **Create a Store for AI**  
+   ```bash
+   CREATESTORE my_store QUERYMODEL dalle3 INDEXMODEL dalle3 PREDICATES (author, country) NONLINEARALGORITHMINDEX (kdtree)
+   ```
+
+2. **Insert AI Data**  
+   ```bash
+   SET (([This is the life of Haks], {name: Haks, category: dev}), ([This is the life of Deven], {name: Deven, category: dev})) in store
+   ```
+
+3. **Query AI Data**  
+   ```bash
+   GETSIMN 4 WITH [random text] USING cosinesimilarity IN store_name WHERE (author = dickens)
+   ```
+
+### List of Supported AI Commands
+
+- `PING`
+- `LISTCLIENTS`
+- `LISTSTORES`
+- `DROPSTORE store_name IF EXISTS`
+- `GETPRED (predicate) IN store_name`
+- `CREATENONLINEARALGORITHMINDEX (algorithm) in store_name`
+- `GETSIMN 4 WITH [text] USING similarity_algorithm IN store_name`
+- And more...
\ No newline at end of file