aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2025-04-12 19:37:18 +0100
committerMohamedBassem <me@mbassem.com>2025-04-12 19:37:40 +0100
commit755fc36e912964863d4f46bb32adda6332b419fe (patch)
tree3c54e9e6ed7686a119804716ccb6fdd6ad0da3c3 /docs
parent7f569042f153a55189fb28e6ef6ab127b8190afd (diff)
downloadkarakeep-755fc36e912964863d4f46bb32adda6332b419fe.tar.zst
chore: Rename hoarder packages to karakeep
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/07-Development/01-setup.md6
-rw-r--r--docs/docs/09-command-line.md30
-rw-r--r--docs/package.json10
3 files changed, 23 insertions, 23 deletions
diff --git a/docs/docs/07-Development/01-setup.md b/docs/docs/07-Development/01-setup.md
index 41e0a902..8e139999 100644
--- a/docs/docs/07-Development/01-setup.md
+++ b/docs/docs/07-Development/01-setup.md
@@ -2,7 +2,7 @@
## Manual Setup
-Hoarder uses `node` version 22. To install it, you can use `nvm` [^1]
+Karakeep uses `node` version 22. To install it, you can use `nvm` [^1]
```
$ nvm install 22
@@ -14,7 +14,7 @@ $ node --version
v22.14.0
```
-Hoarder also makes use of `corepack`[^2]. If you have `node` installed, then `corepack` should already be
+Karakeep also makes use of `corepack`[^2]. If you have `node` installed, then `corepack` should already be
installed on your machine, and you don't need to do anything. To verify the `corepack` is installed run:
```
@@ -44,7 +44,7 @@ Packages: +3129
Progress: resolved 0, reused 2699, downloaded 0, added 3129, done
devDependencies:
-+ @hoarder/prettier-config 0.1.0 <- tooling/prettier
++ @karakeep/prettier-config 0.1.0 <- tooling/prettier
. prepare$ husky
└─ Done in 45ms
diff --git a/docs/docs/09-command-line.md b/docs/docs/09-command-line.md
index 5d404914..a7b7fc87 100644
--- a/docs/docs/09-command-line.md
+++ b/docs/docs/09-command-line.md
@@ -1,6 +1,6 @@
# Command Line Tool (CLI)
-Hoarder comes with a simple CLI for those users who want to do more advanced manipulation.
+Karakeep comes with a simple CLI for those users who want to do more advanced manipulation.
## Features
@@ -10,30 +10,30 @@ Hoarder comes with a simple CLI for those users who want to do more advanced man
## Installation (NPM)
```
-npm install -g @hoarderapp/cli
+npm install -g @karakeep/cli
```
## Installation (Docker)
```
-docker run --rm ghcr.io/hoarder-app/hoarder-cli:release --help
+docker run --rm ghcr.io/karakeep-app/karakeep-cli:release --help
```
## Usage
```
-hoarder
+karakeep
```
```
-Usage: hoarder [options] [command]
+Usage: karakeep [options] [command]
-A CLI interface to interact with the hoarder api
+A CLI interface to interact with the karakeep api
Options:
- --api-key <key> the API key to interact with the API (env: HOARDER_API_KEY)
- --server-addr <addr> the address of the server to connect to (env: HOARDER_SERVER_ADDR)
+ --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
@@ -48,11 +48,11 @@ Commands:
And some of the subcommands:
```
-hoarder bookmarks
+karakeep bookmarks
```
```
-Usage: hoarder bookmarks [options] [command]
+Usage: karakeep bookmarks [options] [command]
Manipulating bookmarks
@@ -70,11 +70,11 @@ Commands:
```
```
-hoarder lists
+karakeep lists
```
```
-Usage: hoarder lists [options] [command]
+Usage: karakeep lists [options] [command]
Manipulating lists
@@ -91,16 +91,16 @@ Commands:
## Optaining an API Key
-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:
+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:
```
-hoarder --api-key <key> --server-addr <addr> whoami
+karakeep --api-key <key> --server-addr <addr> whoami
```
For example:
```
-hoarder --api-key mysupersecretkey --server-addr https://try.hoarder.app whoami
+karakeep --api-key mysupersecretkey --server-addr https://try.karakeep.app whoami
{
id: 'j29gnbzxxd01q74j2lu88tnb',
name: 'Test User',
diff --git a/docs/package.json b/docs/package.json
index 3ea4caf8..57371882 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -1,5 +1,5 @@
{
- "name": "@hoarder/docs",
+ "name": "@karakeep/docs",
"version": "0.0.0",
"private": true,
"scripts": {
@@ -46,12 +46,12 @@
"eslintConfig": {
"root": true,
"extends": [
- "@hoarder/eslint-config/base",
- "@hoarder/eslint-config/nextjs",
- "@hoarder/eslint-config/react"
+ "@karakeep/eslint-config/base",
+ "@karakeep/eslint-config/nextjs",
+ "@karakeep/eslint-config/react"
]
},
- "prettier": "@hoarder/prettier-config",
+ "prettier": "@karakeep/prettier-config",
"engines": {
"node": ">=18.0"
}