Skip to content

Commit

Permalink
docs: Fix some typos in the importing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MohamedBassem committed Apr 2, 2024
1 parent 173ac37 commit cd7ffc6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/docs/09-command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/10-import.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -16,13 +16,13 @@ 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

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 {}
```

0 comments on commit cd7ffc6

Please sign in to comment.