From ae76f9464f2f64018548f4ddfe7b94b92616c6dd Mon Sep 17 00:00:00 2001
From: Mohamed Bassem <me@mbassem.com>
Date: Sun, 13 Apr 2025 16:18:09 +0000
Subject: docs: Release the new API docs

---
 .../version-v0.23.2/09-command-line.md             | 109 +++++++++++++++++++++
 1 file changed, 109 insertions(+)
 create mode 100644 docs/versioned_docs/version-v0.23.2/09-command-line.md

(limited to 'docs/versioned_docs/version-v0.23.2/09-command-line.md')

diff --git a/docs/versioned_docs/version-v0.23.2/09-command-line.md b/docs/versioned_docs/version-v0.23.2/09-command-line.md
new file mode 100644
index 00000000..a7b7fc87
--- /dev/null
+++ b/docs/versioned_docs/version-v0.23.2/09-command-line.md
@@ -0,0 +1,109 @@
+# Command Line Tool (CLI)
+
+Karakeep comes with a simple CLI for those users who want to do more advanced manipulation.
+
+## Features
+
+- Manipulate bookmarks, lists and tags
+- Mass import/export of bookmarks
+
+## Installation (NPM)
+
+```
+npm install -g @karakeep/cli
+```
+
+
+## Installation (Docker)
+
+```
+docker run --rm ghcr.io/karakeep-app/karakeep-cli:release --help
+```
+
+## Usage
+
+```
+karakeep
+```
+
+```
+Usage: karakeep [options] [command]
+
+A CLI interface to interact with the karakeep api
+
+Options:
+  --api-key <key>       the API key to interact with the API (env: KARAKEEP_API_KEY)
+  --server-addr <addr>  the address of the server to connect to (env: KARAKEEP_SERVER_ADDR)
+  -V, --version         output the version number
+  -h, --help            display help for command
+
+Commands:
+  bookmarks             manipulating bookmarks
+  lists                 manipulating lists
+  tags                  manipulating tags
+  whoami                returns info about the owner of this API key
+  help [command]        display help for command
+```
+
+And some of the subcommands:
+
+```
+karakeep bookmarks
+```
+
+```
+Usage: karakeep bookmarks [options] [command]
+
+Manipulating bookmarks
+
+Options:
+  -h, --help             display help for command
+
+Commands:
+  add [options]          creates a new bookmark
+  get <id>               fetch information about a bookmark
+  update [options] <id>  updates bookmark
+  list [options]         list all bookmarks
+  delete <id>            delete a bookmark
+  help [command]         display help for command
+
+```
+
+```
+karakeep lists
+```
+
+```
+Usage: karakeep lists [options] [command]
+
+Manipulating lists
+
+Options:
+  -h, --help                 display help for command
+
+Commands:
+  list                       lists all lists
+  delete <id>                deletes a list
+  add-bookmark [options]     add a bookmark to list
+  remove-bookmark [options]  remove a bookmark from list
+  help [command]             display help for command
+```
+
+## Optaining an API Key
+
+To use the CLI, you'll need to get an API key from your karakeep settings. You can validate that it's working by running:
+
+```
+karakeep --api-key <key> --server-addr <addr> whoami
+```
+
+For example:
+
+```
+karakeep --api-key mysupersecretkey --server-addr https://try.karakeep.app whoami
+{
+  id: 'j29gnbzxxd01q74j2lu88tnb',
+  name: 'Test User',
+  email: 'test@gmail.com'
+}
+```
-- 
cgit v1.2.3-70-g09d2