Merge pull request #8 from faroedev/cli-data-dir

CLI: Add `--dir` option to serve command
faroedev · Oct 28, 2024 · 88da67e · 88da67e
2 parents b6a28f6 + 0e6118a
commit 88da67e
Show file tree

Hide file tree

Showing 87 changed files with 307 additions and 298 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.1
+
+- Added `--dir` option `serve` command.˝
+
 ## 0.2.0
 
 - Removed `email` field from user model.

diff --git a/docs/malta.config.json b/docs/malta.config.json
@@ -35,8 +35,9 @@
         {
             "title": "API reference",
             "pages": [
-                ["Rest API", "/api-reference/rest"],
-                ["JavaScript SDK", "/api-reference/sdk-js"]
+                ["CLI", "/reference/cli"],
+                ["Rest API", "/reference/rest"],
+                ["JavaScript SDK", "/reference/sdk-js"]
             ]
         },
         {

diff --git a/docs/pages/api-reference/rest/index.md b/docs/pages/api-reference/rest/index.md
diff --git a/docs/pages/api-reference/sdk-js/main/Faroe/index.md b/docs/pages/api-reference/sdk-js/main/Faroe/index.md
diff --git a/docs/pages/api-reference/sdk-js/main/index.md b/docs/pages/api-reference/sdk-js/main/index.md
diff --git a/docs/pages/reference/cli/index.md b/docs/pages/reference/cli/index.md
@@ -0,0 +1,33 @@
+---
+title: "CLI reference"
+---
+
+# CLI reference
+
+## generate-secret
+
+Generates a random secret with 200 bits of entropy using a cryptographically secure source. 
+
+```
+faroe generate-secret
+```
+
+## serve
+
+Creates a `faroe_data` directory with an SQLite database file if it doesn't already exist and starts the server on port 4000.
+
+```
+faroe serve [...options]
+```
+
+### Options
+
+- `--port`: The port number (default: 4000).
+- `--dir`: The path of the directory to store data (default: `faroe_data`). 
+- `--secret`: A random secret. If provided, requires requests to the server to include the secret in the `Authorization` header.
+
+### Example
+
+```
+faroe serve --port=3000 --dir="/data/faroe" --secret=SECURE_SECRET
+```
diff --git a/...delete_email-update-requests_requestid.md → ...delete_email-update-requests_requestid.md b/...delete_email-update-requests_requestid.md → ...delete_email-update-requests_requestid.md
diff --git a/...lete_password-reset-requests_requestid.md → ...lete_password-reset-requests_requestid.md b/...lete_password-reset-requests_requestid.md → ...lete_password-reset-requests_requestid.md
diff --git a/...nce/rest/endpoints/delete_users_userid.md → ...nce/rest/endpoints/delete_users_userid.md b/...nce/rest/endpoints/delete_users_userid.md → ...nce/rest/endpoints/delete_users_userid.md
diff --git a/...ete_users_userid_email-update-requests.md → ...ete_users_userid_email-update-requests.md b/...ete_users_userid_email-update-requests.md → ...ete_users_userid_email-update-requests.md
diff --git a/...sers_userid_email-verification-request.md → ...sers_userid_email-verification-request.md b/...sers_userid_email-verification-request.md → ...sers_userid_email-verification-request.md
diff --git a/...e_users_userid_password-reset-requests.md → ...e_users_userid_password-reset-requests.md b/...e_users_userid_password-reset-requests.md → ...e_users_userid_password-reset-requests.md
diff --git a/...ts/delete_users_userid_totp-credential.md → ...ts/delete_users_userid_totp-credential.md b/...ts/delete_users_userid_totp-credential.md → ...ts/delete_users_userid_totp-credential.md
diff --git a/...ts/get_email-update-requests_requestid.md → ...ts/get_email-update-requests_requestid.md b/...ts/get_email-update-requests_requestid.md → ...ts/get_email-update-requests_requestid.md
@@ -12,7 +12,7 @@ GET https://your-domain.com/email-update-requests/[request_id]
 
 ## Successful response
 
-Returns the [email update request model](/api-reference/rest/models/email-update-request) if the request exists and is valid.
+Returns the [email update request model](/reference/rest/models/email-update-request) if the request exists and is valid.
 
 ## Error codes
 

diff --git a/.../get_password-reset-requests_requestid.md → .../get_password-reset-requests_requestid.md b/.../get_password-reset-requests_requestid.md → .../get_password-reset-requests_requestid.md
@@ -12,7 +12,7 @@ GET https://your-domain.com/password-reset-requests/REQUEST_ID
 
 ## Successful response
 
-Returns the [password reset request model](/api-reference/rest/models/password-reset-request) if the request exists and is valid.
+Returns the [password reset request model](/reference/rest/models/password-reset-request) if the request exists and is valid.
 
 ## Error codes
 

diff --git a/...api-reference/rest/endpoints/get_users.md → ...ges/reference/rest/endpoints/get_users.md b/...api-reference/rest/endpoints/get_users.md → ...ges/reference/rest/endpoints/get_users.md
@@ -31,7 +31,7 @@ All parameters are optional.
 
 ## Successful response
 
-Returns a JSON array of [user models](/api-reference/rest/models/user). If there are no users in the page, it will return an empty array.
+Returns a JSON array of [user models](/reference/rest/models/user). If there are no users in the page, it will return an empty array.
 
 You can get the number of total pages from the `X-Pagination-Total-Pages` header and the total number of users with the `X-Pagination-Total` header..
 

diff --git a/...erence/rest/endpoints/get_users_userid.md → ...erence/rest/endpoints/get_users_userid.md b/...erence/rest/endpoints/get_users_userid.md → ...erence/rest/endpoints/get_users_userid.md
@@ -12,7 +12,7 @@ GET https://your-domain.com/users/USER_ID
 
 ## Successful response
 
-Returns the [user model](/api-reference/rest/models/user) of the user if they exist.
+Returns the [user model](/reference/rest/models/user) of the user if they exist.
 
 ## Error codes
 

diff --git a/...get_users_userid_email-update-requests.md → ...get_users_userid_email-update-requests.md b/...get_users_userid_email-update-requests.md → ...get_users_userid_email-update-requests.md
@@ -12,7 +12,7 @@ GET https://your-domain.com/users/USER_ID/email-update-requests
 
 ## Successful response
 
-Returns a JSON array of [email update request models](/api-reference/rest/models/email-update-request). If the user does not have any update requests, it will return an empty array.
+Returns a JSON array of [email update request models](/reference/rest/models/email-update-request). If the user does not have any update requests, it will return an empty array.
 
 ### Example
 

diff --git a/...sers_userid_email-verification-request.md → ...sers_userid_email-verification-request.md b/...sers_userid_email-verification-request.md → ...sers_userid_email-verification-request.md
@@ -12,7 +12,7 @@ GET https://your-domain.com/users/USER_ID/email-verification-reqes
 
 ## Successful response
 
-Returns the [user email verification request model](/api-reference/rest/models/user-email-verification-request) if the request exists and is valid.
+Returns the [user email verification request model](/reference/rest/models/user-email-verification-request) if the request exists and is valid.
 
 ## Error codes
 

diff --git a/...t_users_userid_password-reset-requests.md → ...t_users_userid_password-reset-requests.md b/...t_users_userid_password-reset-requests.md → ...t_users_userid_password-reset-requests.md
@@ -12,7 +12,7 @@ GET https://your-domain.com/users/USER_ID/password-reset-requests
 
 ## Successful response
 
-Returns a JSON array of [password reset request models](/api-reference/rest/models/password-reset-request). If the user does not have any update requests, it will return an empty array.
+Returns a JSON array of [password reset request models](/reference/rest/models/password-reset-request). If the user does not have any update requests, it will return an empty array.
 
 ### Example
 

diff --git a/...oints/get_users_userid_totp-credential.md → ...oints/get_users_userid_totp-credential.md b/...oints/get_users_userid_totp-credential.md → ...oints/get_users_userid_totp-credential.md
@@ -12,7 +12,7 @@ GET https://your-domain.com/users/USER_ID/totp-credential
 
 ## Response body
 
-Returns the [user TOTP credential model](/api-reference/rest/models/user-totp-credential) of the credential if it exists.
+Returns the [user TOTP credential model](/reference/rest/models/user-totp-credential) of the credential if it exists.
 
 ## Error codes
 

diff --git a/...-reset-requests_requestid_verify-email.md → ...-reset-requests_requestid_verify-email.md b/...-reset-requests_requestid_verify-email.md → ...-reset-requests_requestid_verify-email.md
diff --git a/...nce/rest/endpoints/post_reset-password.md → ...nce/rest/endpoints/post_reset-password.md b/...nce/rest/endpoints/post_reset-password.md → ...nce/rest/endpoints/post_reset-password.md
diff --git a/...pi-reference/rest/endpoints/post_users.md → ...es/reference/rest/endpoints/post_users.md b/...pi-reference/rest/endpoints/post_users.md → ...es/reference/rest/endpoints/post_users.md
@@ -35,7 +35,7 @@ POST https://your-domain.com/users
 
 ## Successful response
 
-Returns the [user model](/api-reference/rest/models/user) of the created user.
+Returns the [user model](/reference/rest/models/user) of the created user.
 
 ## Error codes
 

diff --git a/...ost_users_userid_email-update-requests.md → ...ost_users_userid_email-update-requests.md b/...ost_users_userid_email-update-requests.md → ...ost_users_userid_email-update-requests.md
@@ -24,7 +24,7 @@ POST https://your-domain.com/users/USER_ID/email-update-requests
 
 ## Successful response
 
-Returns the [email update request model](/api-reference/rest/models/email-verification-request) of the created request.
+Returns the [email update request model](/reference/rest/models/email-verification-request) of the created request.
 
 ## Error codes
 

diff --git a/...sers_userid_email-verification-request.md → ...sers_userid_email-verification-request.md b/...sers_userid_email-verification-request.md → ...sers_userid_email-verification-request.md
@@ -12,7 +12,7 @@ POST https://your-domain.com/users/USER_ID/email-verification-request
 
 ## Successful response
 
-Returns the [user email verification request model](/api-reference/rest/models/user-email-verification-request) of the created request.
+Returns the [user email verification request model](/reference/rest/models/user-email-verification-request) of the created request.
 
 ## Error codes
 

diff --git a/...t_users_userid_password-reset-requests.md → ...t_users_userid_password-reset-requests.md b/...t_users_userid_password-reset-requests.md → ...t_users_userid_password-reset-requests.md
@@ -30,7 +30,7 @@ POST https://your-domain.com/users/USER_ID/password-reset-requests
 
 ## Successful response
 
-Returns the [password reset request model](/api-reference/rest/models/password-reset-requests-request) of the created request and a verification code. The code is only available here.
+Returns the [password reset request model](/reference/rest/models/password-reset-requests-request) of the created request and a verification code. The code is only available here.
 
 ```ts
 {

diff --git a/..._users_userid_regenerate-recovery-code.md → ..._users_userid_regenerate-recovery-code.md b/..._users_userid_regenerate-recovery-code.md → ..._users_userid_regenerate-recovery-code.md
diff --git a/...points/post_users_userid_register-totp.md → ...points/post_users_userid_register-totp.md b/...points/post_users_userid_register-totp.md → ...points/post_users_userid_register-totp.md
@@ -26,7 +26,7 @@ All fields are required.
 
 ## Response body
 
-Returns the [user TOTP credential model](/api-reference/rest/models/user-totp-credential) of the registered credential.
+Returns the [user TOTP credential model](/reference/rest/models/user-totp-credential) of the registered credential.
 
 ## Error codes
 

diff --git a/.../endpoints/post_users_userid_reset-2fa.md → .../endpoints/post_users_userid_reset-2fa.md b/.../endpoints/post_users_userid_reset-2fa.md → .../endpoints/post_users_userid_reset-2fa.md
diff --git a/...ints/post_users_userid_update-password.md → ...ints/post_users_userid_update-password.md b/...ints/post_users_userid_update-password.md → ...ints/post_users_userid_update-password.md
diff --git a/...ints/post_users_userid_verify-2fa_totp.md → ...ints/post_users_userid_verify-2fa_totp.md b/...ints/post_users_userid_verify-2fa_totp.md → ...ints/post_users_userid_verify-2fa_totp.md
diff --git a/...dpoints/post_users_userid_verify-email.md → ...dpoints/post_users_userid_verify-email.md b/...dpoints/post_users_userid_verify-email.md → ...dpoints/post_users_userid_verify-email.md
diff --git a/...ints/post_users_userid_verify-password.md → ...ints/post_users_userid_verify-password.md b/...ints/post_users_userid_verify-password.md → ...ints/post_users_userid_verify-password.md
diff --git a/...e/rest/endpoints/post_verify-new-email.md → ...e/rest/endpoints/post_verify-new-email.md b/...e/rest/endpoints/post_verify-new-email.md → ...e/rest/endpoints/post_verify-new-email.md