aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.27.0/09-command-line.md
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-09-07 17:51:12 +0000
committerMohamed Bassem <me@mbassem.com>2025-09-07 17:51:12 +0000
commit13856a1fb33b1f2f07dddb32ac07db2bb0e82da3 (patch)
tree60d433efa07d2fa46485ecf9e99f7aa3ff72bd2e /docs/versioned_docs/version-v0.27.0/09-command-line.md
parent53f33d9975ae63498e64139efe41aafc8ea41d43 (diff)
downloadkarakeep-13856a1fb33b1f2f07dddb32ac07db2bb0e82da3.tar.zst
release(docs): release the 0.27 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.27.0/09-command-line.md')
-rw-r--r--docs/versioned_docs/version-v0.27.0/09-command-line.md114
1 files changed, 114 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.27.0/09-command-line.md b/docs/versioned_docs/version-v0.27.0/09-command-line.md
new file mode 100644
index 00000000..c8b00696
--- /dev/null
+++ b/docs/versioned_docs/version-v0.27.0/09-command-line.md
@@ -0,0 +1,114 @@
+# 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
+```
+
+## Obtaining 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'
+}
+```
+
+
+## Other clients
+
+There also exists a **non-official**, community-maintained, python package called [karakeep-python-api](https://github.com/thiswillbeyourgithub/karakeep_python_api) that can be accessed from the CLI, but is **not** official.