Add docs on dump format

Signed-off-by: Alex Saveau <[email protected]>
SUPERCILEX · Jun 27, 2024 · fcdb188 · fcdb188
1 parent bd52030
commit fcdb188
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/cli/command-reference.golden b/cli/command-reference.golden
@@ -263,7 +263,14 @@ Options:
 
 ---
 
-Dump the contents of the database for analysis
+Dump the contents of the database for analysis.
+
+The JSON format is as follows:
+ {
+ "id": int64,
+ "kind": "Human" | "Bytes",
+ "data": (UTF-8 | base64) string
+ }
 
 Usage: clipboard-history debug dump [OPTIONS]
 

diff --git a/cli/src/main.rs b/cli/src/main.rs
@@ -159,6 +159,13 @@ enum Dev {
     Stats,
 
     /// Dump the contents of the database for analysis.
+    ///
+    /// The JSON format is as follows:{n}
+    /// {{n}
+    ///   "id": int64,{n}
+    ///   "kind": "Human" | "Bytes",{n}
+    ///   "data": (UTF-8 | base64) string{n}
+    /// }{n}
     #[command(alias = "export")]
     Dump(Dump),