diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:25:03 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:25:03 +0000 |
| commit | f3c525b7f7dd360f654d8621bbf64e31ad5ff48e (patch) | |
| tree | f9c8378e5c24caf1441f055d0d08b60f8b91a0ab /docs/versioned_docs/version-v0.23.2/09-command-line.md | |
| parent | ae76f9464f2f64018548f4ddfe7b94b92616c6dd (diff) | |
| download | karakeep-f3c525b7f7dd360f654d8621bbf64e31ad5ff48e.tar.zst | |
docs: Revert 0.23.2 docs and just update 0.23.1 instead
Diffstat (limited to 'docs/versioned_docs/version-v0.23.2/09-command-line.md')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.2/09-command-line.md | 109 |
1 files changed, 0 insertions, 109 deletions
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 deleted file mode 100644 index a7b7fc87..00000000 --- a/docs/versioned_docs/version-v0.23.2/09-command-line.md +++ /dev/null @@ -1,109 +0,0 @@ -# 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' -} -``` |