From 8eaa8511f54ac5023a03d6411a86f7a1ef38a600 Mon Sep 17 00:00:00 2001 From: Aervyon Date: Tue, 13 Feb 2024 04:28:41 -0600 Subject: [PATCH] docs(foldcli): update foldcli's documentation --- Guides/CLI/beta/commands.md | 43 +++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/Guides/CLI/beta/commands.md b/Guides/CLI/beta/commands.md index 70fee62..68bafaf 100644 --- a/Guides/CLI/beta/commands.md +++ b/Guides/CLI/beta/commands.md @@ -1,14 +1,14 @@ # CLI Commands -Hi, were going to be covering the CLI commands that come with the current version of **Folderr CLI** +Hi, were going to be covering the CLI commands that come with the current version of **foldcli** Please note this page is a work in progress ## Table of Contents -* [Initial Setup](#setup) -* [App & Services Setup](#setup-applications-and-services) -* [Miscellaneous](#miscellaneous) +- [Initial Setup](#setup) +- [App & Services Setup](#setup-applications-and-services) +- [Miscellaneous](#miscellaneous) ## Setup @@ -59,10 +59,11 @@ Flags: Next we have the `setup owner` command which sets up the owner account on the Folderr instance. Won't work if there is already an owner + ```sh foldcli setup owner -Set's up the owner account on your Folderr instance +Sets up the owner account on your Folderr instance Requires MONGO_URI environment variable to be set db_name is required for uploading the account Runs interactively if the all the flags are not set. Will use any flags set however. @@ -81,6 +82,7 @@ Global Flags: ``` Next we have the `install` command which installs Folderr. May be used later for more things. + ```sh foldcli install Checks for Folderrs dependencies and installs Folderr @@ -96,14 +98,41 @@ Global Flags: --dry Runs the command but does not change anything ``` +## Encryption Key Management + +The `keygen` command is useful for generating public/private keypairs for Folderr + +It also allows us to test `foldcli`s keys againt Folderr, which is made especially easy with [this repository](https://github.com/Folderr/jwt-keytests) + +```sh +foldcli keygen + +Generate a private/public keypair according to Folderrs standards + +Usage: + foldcli keygen [flags] + +Examples: +foldcli keygen /home/fldrr/keys/private.pem /home/fldrr/keys/public.pem + +Flags: + -f, --force Override the current keys, if they eixst + -h, --help help for keygen + +Global Flags: + --dry Runs the command but does not change anything +``` + ## Miscellaneous The only command we have here for now is the `version` command. Which prints the version -May have more versions than just the Folderr CLIs later. +May have more versions than just foldcli's later. + ```sh foldcli version Shows the version of the CLI Usage: foldcli version ``` -Current version as of writing: Alpha 0.0.2 + +Current version as of writing: Alpha 0.0.6