From e41f53b6925a0751de69951fcd23f73f25cc90c1 Mon Sep 17 00:00:00 2001
From: MrBounty <adrien.bouvais.pro@gmail.com>
Date: Tue, 26 Nov 2024 20:10:22 +0100
Subject: [PATCH] Update commands docs

---
 docs/Commands.md | 115 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 115 insertions(+)

diff --git a/docs/Commands.md b/docs/Commands.md
index e69de29..f44cd93 100644
--- a/docs/Commands.md
+++ b/docs/Commands.md
@@ -0,0 +1,115 @@
+# Command Line Interface
+
+## run
+
+Run a ZiQL query on the selected database.
+
+**Usage:**
+
+```
+run QUERY
+```
+
+## db
+
+**Usage:**
+
+```
+db COMMAND
+```
+
+### db metrics
+
+Print some metrics from the db, including: Size on disk and number of entities stored.
+
+**Usage:**
+
+```
+db metrics [OPTIONS]
+```
+
+**Options:**
+
+Name | Type | Description         | Default
+---- | ---- | ------------------- | ----
+TODO | TODO | TODO | TODO
+
+### db new
+
+Create a new empty directory that can be then initialize with a schema.
+
+**Usage:**
+
+```
+db new path/to/dir [OPTIONS]
+```
+
+**Options:**
+
+Name | Type | Description         | Default
+---- | ---- | ------------------- | ----
+TODO | TODO | TODO | TODO
+
+### db use
+
+Select an already created database with `db new`.
+
+**Usage:**
+
+```
+db use path/to/dir [OPTIONS]
+```
+
+**Options:**
+
+Name | Type | Description         | Default
+---- | ---- | ------------------- | ----
+TODO | TODO | TODO | TODO
+
+### db state - WIP
+
+Return the state of the database, either `MissingDatabase` if no database selected or `MissingSchema` if no schema was initialize.
+
+**Usage:**
+
+```
+db state
+```
+
+## schema
+
+### schema init
+
+Initialize the database using a schema file.
+
+**Usage:**
+
+```
+schema use path/to/schema.file [OPTIONS]
+```
+
+**Options:**
+
+Name | Type | Description         | Default
+---- | ---- | ------------------- | ----
+TODO | TODO | TODO | TODO
+
+## quit
+
+Quit the CLI.
+
+**Usage:**
+
+```
+quit
+```
+
+## help
+
+Write an help message.
+
+**Usage:**
+
+```
+help
+```