aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2024-04-02 22:49:19 +0100
committerMohamedBassem <me@mbassem.com>2024-04-02 22:49:19 +0100
commitcd7ffc66f28c4add0d26a86b0ae534973f928989 (patch)
tree8bf467d348a930ef1d16a65940b523f35822f08f /docs
parent173ac3776ef64bfb298493b180cb7e6d040897d9 (diff)
downloadkarakeep-cd7ffc66f28c4add0d26a86b0ae534973f928989.tar.zst
docs: Fix some typos in the importing docs
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/09-command-line.md6
-rw-r--r--docs/docs/10-import.md6
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/docs/09-command-line.md b/docs/docs/09-command-line.md
index ca54394c..8c568adb 100644
--- a/docs/docs/09-command-line.md
+++ b/docs/docs/09-command-line.md
@@ -3,19 +3,19 @@
Hoarder comes with a simple CLI for those users who want to do more advanced manipulation. Currently, the CLI comes packaged as a docker container. You can run it with:
```
-docker run --rm ghcr.io/mohamedbassem/hoarder-cli --help
+docker run --rm ghcr.io/mohamedbassem/hoarder-cli:release --help
```
To use the CLI, you'll need to get an API key from your hoarder settings. You can validate that it's working by running:
```
-docker run --rm ghcr.io/mohamedbassem/hoarder-cli --api-key <key> --server-addr <addr> whoami
+docker run --rm ghcr.io/mohamedbassem/hoarder-cli:release --api-key <key> --server-addr <addr> whoami
```
For example:
```
-docker run --rm ghcr.io/mohamedbassem/hoarder-cli --api-key mysupersecretkey --server-addr https://try.hoarder.app whoami
+docker run --rm ghcr.io/mohamedbassem/hoarder-cli:release --api-key mysupersecretkey --server-addr https://try.hoarder.app whoami
{
id: 'j29gnbzxxd01q74j2lu88tnb',
name: 'Test User',
diff --git a/docs/docs/10-import.md b/docs/docs/10-import.md
index 044afe7f..0de0c282 100644
--- a/docs/docs/10-import.md
+++ b/docs/docs/10-import.md
@@ -1,7 +1,7 @@
# Importing Bookmarks
:::warning
-Currently importing bookmarks requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord thouh.
+Currently importing bookmarks requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord though.
:::
## Import from Chrome
@@ -16,7 +16,7 @@ Currently importing bookmarks requires some technical knowledge and might not be
Run the following command to import all the links from `all_links.txt`:
```
-cat all_links.txt | xargs -I{} docker run --rm ghcr.io/mohamedbassem/hoarder-cli:release --api-key <key> --server-addr <addr> bookmark add --link {}
+cat all_links.txt | xargs -I{} docker run --rm ghcr.io/mohamedbassem/hoarder-cli:release --api-key <key> --server-addr <addr> bookmarks add --link {}
```
## Import from other platforms
@@ -24,5 +24,5 @@ cat all_links.txt | xargs -I{} docker run --rm ghcr.io/mohamedbassem/hoarder-cli
If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [hoarder cli](https://docs.hoarder.app/command-line):
```
-cat all_links.txt | xargs -I{} docker run --rm ghcr.io/mohamedbassem/hoarder-cli:release --api-key <key> --server-addr <addr> bookmark add --link {}
+cat all_links.txt | xargs -I{} docker run --rm ghcr.io/mohamedbassem/hoarder-cli:release --api-key <key> --server-addr <addr> bookmarks add --link {}
```