@affinidi/cli 2.0.0-beta.3 → 2.0.0-beta.5

package/README.md

@@ -1,1046 +1,1290 @@
 # Affinidi CLI
 
-[Introduction](#introduction)
+Affinidi CLI is a developer tool to easily manage your projects and integration with Affinidi services using command line. It empowers developers to use simple commands to improve developer experience when interacting with our different services.
 
-[Features](#features)
+## Requirements
 
-[Installation](#installation)
+- [NodeJs v18 or higher](https://nodejs.org)
+- A Chromium-based browser such as [Chrome](https://www.google.com/chrome/), [Microsoft Edge](https://www.microsoft.com/edge/download), [Opera](https://www.opera.com/) or [Brave](https://brave.com/)
+- Install Affinidi Vault [extension](https://chrome.google.com/webstore/detail/fejpjjkbaklcdcibmkbmpanjbiihclon) in your browser
+- To generate reference applications you will also need [git](https://git-scm.com/)
 
-[Quick Start](#quick-start)
+## Installation
 
-[CLI Commands](#cli-commands)
+Install the latest beta version of Affinidi CLI
 
-[About Schemas and Verifiable Credentials](#about-schemas-and-verifiable-credentials)
+```bash
+npm install -g @affinidi/cli@beta
+```
 
-[Feedback & Support](#feedback--support)
+Uninstall the Affinidi CLI
 
-[FAQ](#faq)
+```bash
+npm uninstall -g @affinidi/cli
+```
 
+## What can I do with Affinidi CLI?
 
-## Introduction
+Affinidi CLI is all you need to interact and consume Affinidi services. Optionally you can also use [Affinidi Portal](https://portal.affinidi.com/) or call Affinidi APIs directly.
 
-Affinidi’s vision is to empower communities with control and ownership of their data,
-creating new business models and greater trust.
+### Set up Affinidi Login for your applications
 
-As the customer demand for control and ownership of data continues to grow, it is
-becoming increasingly important for developers to better manage data privacy and portability
-within their apps. With our tooling, you can start creating a privacy-preserving app within minutes.
+Affinidi CLI allows you to make the necessary configurations to add [Affinidi Login](https://www.affinidi.com/product/affinidi-login) to you applications for a secure, passwordless and privacy preserving login experience.
 
-### What are privacy-preserving apps?
+Learn more about how Affinidi Login works in the [documentation site](https://docs.affinidi.com/docs/affinidi-login/how-affinidi-login-works/).
 
-Privacy-preserving apps make it easy to give your customers more control over how their information is used and shared. We enable this data ownership and control through Decentralized Identifiers (DIDs) and Verifiable Credentials (VCs).
+All of the Affinidi Login commands can be found under `affinidi login <command>`
 
-Learn more about [VCs](https://academy.affinidi.com/what-are-verifiable-credentials-79f1846a7b9), [trust triangle](https://academy.affinidi.com/what-is-the-trust-triangle-9a9caf36b321), [Decentralized Identifiers (DIDs)](https://academy.affinidi.com/demystifying-decentralized-identifiers-dids-2dc6fc3148fd), and [selective disclosure](https://academy.affinidi.com/a-detailed-guide-on-selective-disclosure-87b89cea1602).
-&nbsp;
+#### Login Configuration
 
-&nbsp;
+The first thing you will want to do is create a login configuration. Read more about login configuration parameters [here](https://docs.affinidi.com/docs/affinidi-login/login-configuration/).
 
-## Features
+To create a login configuration use: [`affinidi login create-config`](#affinidi-login-create-config)
 
-The following features are available through Affinidi CLI:
+Your login configuration will be created under your CLI's active project. Learn more about [projects](#manage-your-projects) and the CLI's [active project](#active-project) below.
 
-### Affinidi account
+#### User Groups
 
-- create and manage your Affinidi account
-- create projects, to better organise and manage what you are building
-- access your API keys
+You may also want to create user groups for your application. They allow you to set access privileges for your users inside your application. Learn more about user groups [here](https://docs.affinidi.com/docs/affinidi-login/user-groups/).
 
-### Schemas
+To create a user group use: [`affinidi login create-group`](#affinidi-login-create-group)
 
-- create and manage schemas, which serve as templates to issue credentials
+To add users to a group use: [`affinidi login add-user-to-group`](#affinidi-login-add-user-to-group)
 
-### Verifiable Credentials (VCs)
+#### Generate an Affinidi Login example application
 
-VCs are tamper-evident credentials that can be verified cryptographically.
-With Affinidi CLI you can:
+Integrating Affinidi Login in your application is straightforward as it uses the open standards of OAuth 2.0 and OpenID Connect with the addition of Verifiable Presentation support (OID4VP). As such you can use the tools your are already familiar.
 
-- issue VCs in bulk or individually
-- verify VCs
+We have prepared an reference application that uses Next.js, NextAuth.js and Auth0 to get you started.
 
-### Reference App
+To generate a reference application use: [`affinidi generate app`](#affinidi-generate-app)
 
-Generate four ready-to-use applications that use Affinidi APIs.
+The reference application has an MIT license, so feel free to use it as you please.
 
-**[The Portable Reputation app](https://github.com/affinidi/reference-app-portable-rep)** allows the builder to connect to different data sources to construct a portable, user-owned and -managed reputation app that provides access to specific experiences, events or memberships.
+#### Journey summary
 
-**[The Certification and Verification app](https://github.com/affinidi/reference-app-certification-and-verification)** includes such features as: issuing a credential, claiming & storing it in your wallet, verifying it. It includes 3 use cases:
+```bash
+# 1. Authenticate to Affinidi
+affinidi start
 
-- **Ticketing** - uses event tickets;
+# 2. Create your Identity Provider application and copy it's login callback URL
+#    For Auth0 this is  https://{auth0-app-domain}/login/callback
 
-- **Health** - uses medical prescriptions;
+# 3. Create your login configuration
+affinidi login create-config -n MyNewLoginConfig -u "https://my-fancy-project.eu.auth0.com/login/callback"
 
-- **Education** - uses students' certificates.
+# 2. Create the Affinidi Login social connector on your Identity Provider application
+#    Auth0 example: https://docs.affinidi.com/labs/affinidi-login-auth0/#configure-auth0-social-connection-with-affinidi-login
 
-#
+# 4. Generate a reference application with your login configuration
+affinidi generate app
 
-## Installation
+# 5. Run the reference application
+```
 
-### Prerequisites:
+### Manage your Affinidi resources and their access
 
-You need to have installed on your machine:
+For you and your team, as builders, Affinidi offers comprehensive IAM solutions:
 
-- [git](https://git-scm.com/)
-- [NodeJs v16 and higher](https://nodejs.org). (it's recommended to use [nvm](https://github.com/nvm-sh/nvm))
+#### Manage your projects
 
-Run the installation command:
+Affinidi projects allow you to manage and isolate Affinidi resources for your solution. You can also add or remove collaborators, manage permissions, enable billing and more. Think of them as Azure Resource Groups or GCP Projects.
 
-```
-npm install -g @affinidi/cli
-```
+When you first login into the CLI a default project is automatically created for you.
 
-To check Affinidi CLI version:
+All project commands can be found under `affinidi project <command>`
 
-```
-affinidi --version
-```
+Create a project with [`affinidi project create-project`](#affinidi-project-create-project)
 
-&nbsp;
+For convenience, the CLI adds the concept of Active Project. This is the project you are currently working on. Read more about the CLI's [active project](#active-project) below.
 
-## Quick Start
+#### Create Personal Access Tokens (PAT) to call Affinidi APIs
 
-To start using our privacy-preserving tools, please follow the next two steps:
+To programmatically call Affinidi APIs in your applications or in your automation you will require a Personal Access Token (PAT). Think of Personal Access Tokens as machine users that can perform operations on your behalf. PATs live outside of projects, meaning that they can be granted access to multiple projects.
 
-1. authenticate by creating an account, or logging in to your account if you already have one
-2. create a project, or activate a project if you already created one
+PATs use asymmetric keys where you are responsible of creating and maintaining the key pair. Please read about more about how PAT authentication works and how you can create the keys [here](#how-does-pat-authentication-work).
 
-### Authentication:
+All PAT commands can be found under `affinidi token <command>`
 
-You will need your email address, and then the code sent to your email to confirm authentication.
+Create a PAT with [`affinidi token create-token`](#affinidi-token-create-token)
 
-To create an account:
+#### Assign users and PATs to your projects and grant them permissions (IAM)
 
-```
-affinidi sign-up
-```
+You can grant access to your project resources to other users or to your PATs. To do so you need to add them to your project and set their policies.
 
-If you already have an account:
+These IAM commands work under a project, so make sure to set the desired [active project](#active-project) before running them.
 
-```
-affinidi login
-```
+All IAM commands can be found under `affinidi iam <command>`
 
-Full reference for each command can be found here:
-[`sign-up`](#affinidi-sign-up)
-[`login`](#affinidi-login)
+1. Add a user or a PAT to the project with [`affinidi iam add-principal`](#affinidi-iam-add-principal) - _Principals are either users or PATs (machine users)_
 
-### Create or activate a project:
+2. Set the principal's access policies with [`affinidi iam update-policies`](#affinidi-iam-update-policies) - _Read more about policies [here](#how-do-policies-work)_
 
-The `create` command creates and activates a project. Follow the prompts to choose a name or add a name directly after the command.
+#### Journey summary
 
-```
-affinidi create project
-```
+```bash
+# 1. Authenticate to Affinidi
+affinidi start
 
-The `use` command activates an already existing project:
+# 2. Create a new project
+affinidi project create-project -n MyNewProject
 
-```
-affinidi use project [<project-id>]
-```
+# 3. Set as CLI's active project
+affinidi project select-project
 
-You can also simply type this and follow the prompts to choose from a list of existing projects:
+# 4. Create a PAT
+affinidi token create-token -n MyNewToken -k MyKeyID -f publicKey.pem
 
-```
-affinidi use project
+# 5. Add the user or machine_user (PAT) to the project
+affinidi iam add-principal --principal-id <uuid> --principal-type machine_user
+
+# 6. Set the principal policies
+affinidi iam update-policies --principal-id <uuid> --principal-type machine_user --file policies.json
+
+# 7. Use PAT's private key to get a JWT and call Affinidi Services
 ```
 
-Full reference for each command can be found here:
-[`create`](#affinidi-create)
-[`use`](#affinidi-use)
+## How do I use Affinidi CLI?
 
-### Schemas
+The first thing you will want to do in the CLI to access most features is to authenticate to Affinidi.
 
-To issue a VC you first have to create a schema or choose an existing one:
+### Authenticating to Affinidi
 
-1. A schema can be created using the `create` command. You will need to provide a _schemaName_ and a _description_ in text format as well as a _source_ with the path to the json file with the schema properties.
+Authenticating as a builder is also done with Affinidi Login, which requires you to have the Affinidi Vault extension.
 
+Please install the [extension](https://chrome.google.com/webstore/detail/fejpjjkbaklcdcibmkbmpanjbiihclon), open the extension popup and follow the registration instructions. You can find a user guide to set up your Affinidi Vault [here](https://docs.affinidi.com/docs/get-started/#setup-affinidi-vault).
+
+Once you have registered, authenticate in the CLI with:
+
+```bash
+affinidi start
 ```
- $ affinidi create schema [schemaName] --description=<value> --source=<value>
-```
 
-2. To see available schemas:
+### Command structure and ways to call commands
+
+Commands in Affinidi CLI have the following structure:
 
+```bash
+affinidi <topic> <command> [flags]
 ```
- $ affinidi list schemas
+
+1. All commands starts with the keyword `affinidi`
+2. Topics typically correspond to Affinidi services or domain
+3. Commands corresponds to the actions to perform
+4. Flags are a way to provide the parameters required by the command
+
+You can input flags in different ways. All of the following will work:
+
+```bash
+affinidi login create-config --file="config.json"
+affinidi login create-config --file "config.json"
+affinidi login create-config --file=config.json
+affinidi login create-config --file config.json
+affinidi login create-config -f "config.json"
+affinidi login create-config -f="config.json"
+affinidi login create-config -f"config.json"
+affinidi login create-config -f config.json
+affinidi login create-config -f=config.json
+affinidi login create-config -fconfig.json
 ```
 
-You will need the value of the property `jsonSchemaUrl` of the created or chosen schema to issue VCs.
+### Finding commands
 
-Please see [About Schemas and Verifiable Credentials](#about-schemas-and-verifiable-credentials) for a detailed explanation on schema structures and how to create and find schemas using the [Schema Manager](https://affinidi-schema-manager.prod.affinity-project.org/api-docs/#).
-Full reference for each command can be found here:
-[`create`](#affinidi-create)
-[`list`](#affinidi-list)
+In the [All Commands](#all-commands) section below you can find all of the CLI commands, with their help information, which includes usage, descriptions, flags and examples.
 
-### Verifiable Credentials
+There are some notable commands that don't belong to any topic and may be of use for you:
 
-You can issue and verify VCs within Affinidi CLI.
+[`affinidi commands`](#affinidi-commands) - List all available commands
 
-1. To issue a VC you need to provide the _email_ of the VC's owner, the `jsonSchemaUrl` of the _schema_ on which the VC is based, and a path to the json file with credential _data_.
+[`affinidi search`](#affinidi-search) - Search and navigate through available commands
 
-```
-$ affinidi issue-vc [EMAIL] --schema=<value> --data <value>
-```
+[`affinidi autocomplete`](#affinidi-autocomplete-shell) - Print the instructions to set up command autocomplete
 
-Please see [How to structure a JSON file to issue a VC](#how-to-structure-a-json-file-to-issue-a-vc) for more details.
+[`affinidi help`](#affinidi-help-commands) - Print the help information of a topic or command
 
-2. To verify a VC you need to provide a path to the json file with the credential _data_ to be verified.
+[`affinidi start`](#affinidi-start) Log in to Affinidi
 
-```
-$ affinidi verify-vc --data=<value>
-```
+[`affinidi stop`](#affinidi-stop) Log out of Affinidi
 
-Full reference for each command can be found here:
-[issue-vc](#affinidi-issue-vc)
-[verify-vc](#affinidi-verify-vc)
+### Global flags
 
-### Generate an application
+All commands have some global flags at their disposal.
 
-The [Ticketing reference app](#reference-app) provides a simple web interface for issuing, claiming and verifying VCs. It can be quickly generated by typing:
+`--help` Prints the command's help information.
 
-```
-$ affinidi generate-application --use-case=u ticketing
-```
+`--json` Enforce printing the output in json format. Useful for programmatic usage of CLI.
 
-You can also specify a name with:
+`--no-color` Disables color in the output. Useful if you have trouble distinguishing colors.
 
-```
-$ affinidi generate-application --name=<value> --use-case=ticketing
-```
+### Active Project
 
-For the full reference, please see the [`affinidi generate-application`](#affinidi-generate-application) command below.
+Affinidi CLI introduces a local concept of "Active Project" for convenience. Commands under the `login` and `iam` topics perform actions under a particular project. In order to not have to ask for the project and create the necessary credentials each time you call one of these commands, we ask you to define the CLI's working project once.
 
-&nbsp;
+To check what is the current active project use the command [`affinidi project get-active-project`](#affinidi-project-get-active-project)
 
-&nbsp;
+To switch the active project use the command [`affinidi project select-project`](#affinidi-project-select-project)
 
-#
+When you authenticate to Affinidi, the first project is set as your active one by default. You can specify which project you want to be active with a flag `affinidi start --project-id <uuid>`
 
-## CLI Commands
+### Session and configuration files
 
-### **affinidi analytics**
+When you authenticate to Affinidi with `affinidi start` the CLI will create a folder with two files in your home directory.
 
-The Analytics command lets you opt in or out of sending anonymous usage data..
+`~/.affinidi/oAuthCred.json` - Stores your current session credentials. Keep it secret as this allows you to call Affinidi services.
 
-USAGE
+`~/.affinidi/config-v2.json` - Stores user's CLI configurations (currently none)
 
-```
-$ affinidi analytics [true | false]
-```
+When you run `affinidi stop` your session information is deleted.
 
-FLAGS
+## How does PAT authentication work?
 
-```
--o, --output=(plaintext|json)   [default: plaintext] Formats output view of the chosen project's details
-```
+In the following diagram you can find the flow of how you can set up a Personal Access Token and use it to call Affinidi APIs.
 
-EXAMPLES
+```mermaid
+  flowchart TB
+    subgraph CLI
+      user_token["1.1. Authenticate to Affinidi"]
+      create_project["1.2. Create project"]
+      project_access["1.3. Get project credentials"]
+      create_token["3.1. Create PAT"]
+      add_token_project["3.2. Add PAT to project"]
+      set_policies["3.3. Set PAT policies"]
 
-```
-    $ affinidi analytics true
-```
+      user_token --> create_project
+      create_project --> project_access
+      user_token --> create_token
+      create_token --> add_token_project
+      project_access --> add_token_project
+      add_token_project --> set_policies
+    end
 
-You can also see the help for the command in the CLI:
+    subgraph Application
+      direction TB
+      sign_jwt["4.1. Sign JWT"]
+      delegate_token["4.2. Exchange for delegate token"]
+      call_project_api["4.3. Call Affinidi APIs"]
 
-```
-$ affinidi analytics --help
+      sign_jwt --> delegate_token
+      delegate_token --> call_project_api
+    end
+
+    create_keys["2. Create key pair"]
+    create_keys -. "public key PEM" .-> create_token
+    create_keys -. "private key PEM" .-> sign_jwt
+    set_policies -. "allows" .-> call_project_api
 ```
 
-### **autocomplete**
+1. Authenticate with Affinidi and set up your project
 
-Display autocomplete installation instructions.
+   1. Authenticate with Affinidi - [`affinidi start`](#affinidi-start)
+   2. Create project - [`affinidi project create-project`](#affinidi-project-create-project)
+   3. Get project credentials - [`affinidi project select-project`](#affinidi-project-select-project)
 
-USAGE
+2. Create and secure a key pair
 
-```
-  $ affinidi autocomplete [SHELL] [FLAGS]
-```
+You can create a key pair using [openssl](https://www.openssl.org/docs/man1.1.1/man1/):
 
-ARGUMENTS
+```bash
+# Create an encrypted RSA private key with passphrase "hello"
+openssl genpkey -algorithm RSA -out privateKey.pem -aes-128-cbc -pass pass:hello
 
-```
-  SHELL  Shell type
+# Extract the public key from the private key
+openssl rsa -in privateKey.pem -pubout -out publicKey.pem
 ```
 
-FLAGS
+Remember your passphrase as you will need it later to sign with your private key.
 
-```
-  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
-```
+Optionally you can rely on a cloud provider to securely manage your keys, such as [AWS KMS](https://aws.amazon.com/kms/), [GCP's Cloud KMS](https://cloud.google.com/security-key-management) or [Azure Key Vault](https://azure.microsoft.com/products/key-vault/)
 
-EXAMPLES
+3. Create a PAT and grant it permissions
 
-```
-  $ affinidi autocomplete
+   1. Create PAT - [`affinidi token create-token`](#affinidi-token-create-token)
+   2. Add PAT to project - [`affinidi iam add-principal`](#affinidi-iam-add-principal)
+   3. Set PAT policies - [`affinidi iam update-policies`](#affinidi-iam-update-policies)
 
-  $ affinidi autocomplete bash
+Remember the PAT Key ID as you will need it to sign with your private key. Read more about how to set policies [below](#how-do-policies-work).
 
-  $ affinidi autocomplete zsh
+4. Use the private key to call Affinidi APIs from your application
 
-  $ affinidi autocomplete --refresh-cache
-```
+Learn more how to create a Delegate Tokens to call APIs in the next section.
 
-You can also see the help for the command in the CLI:
+### Delegate tokens
 
-```
-$ affinidi autocomplete --help
-```
+1. To create a delegate token you first need to sign a JWT with your private key. In the snippet below this is done with `signJWT(...)`. This should also be possible with third party key managers.
 
-### **affinidi config**
+2. Once you have a signed JWT you can use it to exchange it for a user scoped token. In the snippet this is done with `getUserToken(...)`. You can use this token to call some Affinidi APIs, however most APIs require a project scoped token.
 
-Use this command to configure CLI settings or delete user saved configurations. Current config settings include:
+3. In the snippet we get a project scope token with `getProjectToken(...)`.
 
-- Output format view
-- Saved Username
+```javascript
+import jwt from 'jsonwebtoken'
+import qs from 'qs'
 
-USAGE
+// Parameters required to sign JWT
+const PRIVATE_KEY = process.env.PRIVATE_KEY
+const ALGORITHM = process.env.ALGORITHM
+const PASSPHRASE = process.env.PASSPHRASE
+const KEY_ID = process.env.KEY_ID
 
-```
-  $ affinidi config SUBCOMMAND [ARGS]
-```
+// Parameter required to sign JWT and get User Scoped Token
+const TOKEN_ID = process.env.TOKEN_ID
 
-SUBCOMMAND
+// Parameter required to get Project Scoped Token
+const PROJECT_ID = process.env.PROJECT_ID
 
-```
-  view          Configures the output view format
+function signJWT(privateKey, algorithm, passphrase, keyId, tokenId) {
+  const issueTimeSeconds = Math.floor(new Date().getTime() / 1000)
+  const payload = {
+    iss: tokenId,
+    sub: tokenId,
+    aud: 'https://euw1.elements.auth.affinidi.io/oauth2/token',
+    jti: new Date().toString() + Math.random(),
+    exp: issueTimeSeconds + 5 * 60,
+    iat: issueTimeSeconds,
+  }
+  const secret = { key: privateKey, passphrase }
+  const options = { algorithm: algorithm, keyid: keyId }
+  return jwt.sign(payload, secret, options)
+}
 
-  username      Persists a username in config file to be used in the future when not providing a username when loggin in
-```
+async function getUserToken(tokenId, signedJWT) {
+  const formData = qs.stringify({
+    grant_type: 'client_credentials',
+    scope: 'openid',
+    client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
+    client_assertion: signedJWT,
+    client_id: tokenId,
+  })
+  const response = await fetch('https://euw1.elements.auth.affinidi.io/oauth2/token', {
+    method: 'POST',
+    body: formData,
+    headers: {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    },
+  })
+  if (response.status !== 200) throw new Error('Could not get user token')
+  return response.json()
+}
 
-CONFIG FLAGS
+async function getProjectToken(projectId, userScopeToken) {
+  const response = await fetch('https://apse1.api.affinidi.io/iam/v1/create-project-scoped-token', {
+    method: 'POST',
+    body: JSON.stringify({ projectId }),
+    headers: {
+      Authorization: `Bearer ${userScopeToken}`,
+      'Content-Type': 'application/json',
+    },
+  })
+  if (response.status !== 200) throw new Error('Could not get project token')
+  return response.json()
+}
 
-```
--u, --unset-all                 Remove username from config
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
+const signedJWT = signJWT(PRIVATE_KEY, ALGORITHM, PASSPHRASE, KEY_ID, TOKEN_ID)
+const userScopeToken = (await getUserToken(TOKEN_ID, signedJWT)).access_token
+const projectScopeToken = (await getProjectToken(PROJECT_ID, userScopeToken)).accessToken
 ```
 
-USERNAME FLAGS
+4. With these tokens you can now call Affinidi APIs:
 
-```
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
+```javascript
+const response = await fetch('https://apse1.api.affinidi.io/vpa/v1/login/configurations', {
+  headers: {
+    Authorization: `Bearer ${projectScopeToken}`,
+  },
+})
+const configurations = await response.json()
+console.log(configurations)
 ```
 
-EXAMPLES
+## How do policies work?
 
-```
- affinidi config --unset-all
+WIP
 
- affinidi config view json
+## Support & Feedback
 
- affinidi config username email@example.com
-```
+If you face any issue or have some suggestion for us please don't hesitate to create a ticket [here](https://share.hsforms.com/1i-4HKZRXSsmENzXtPdIG4g8oa2v).
 
-You can also see the help for the command in the CLI:
+If you have a technical issue with the CLI's codebase, you can also [create an issue](https://github.com/affinidi/affinidi-cli/issues) directly in GitHub.
 
-```
-affinidi config --help
-```
+## FAQ
 
-### **affinidi create**
+### A note from Affinidi
 
-Use this command to create a new resource. Current supported resource types are:
+Affinidi CLI is currently in the open beta phase and we are refining our product every day. The Affinidi CLI may be incomplete and may contain errors – they may be unstable and may cause a loss of functionality and data. Use of the Affinidi CLI will be at your own risk. As our engineers seek to improve our platform, we would not have the resources to provide any maintenance or tech support at this time. Please bear with us as we continue to improve the platform.
 
-- Affinidi project
-- schema
+### What can I develop?
 
-USAGE
+You are only limited by your imagination! Affinidi CLI is a toolbox with which you can build software applications for personal or commercial use.
 
-```
-$ affinidi create SUBCOMMAND [ARGS...] [FLAGS]
-```
+### Is there anything I should not develop?
 
-SUBCOMMANDS
+We only provide the tools - how you use them is largely up to you. We have no control over what you develop with our tools - but please use our tools responsibly!
 
-```
-project          Creates a new Affinidi project.
-schema           Creates a new schema for a verifiable credential.
-```
+We hope that you would not develop anything that contravenes any applicable laws or regulations. Your projects should also not infringe on Affinidi’s or any third party’s intellectual property (for instance, misusing other parties’ data, code, logos, etc).
 
-To create a project:
+### What responsibilities do I have to my end-users?
 
-```
-$ affinidi create project [projectName]
-```
+Please ensure that you have in place your own terms and conditions, privacy policies, and other safeguards to ensure that the projects you build are secure for your end users.
 
-Or simply type this and follow the prompts:
+If you are processing personal data, please protect the privacy and other legal rights of your end-users and store their personal or sensitive information securely.
 
-```
-$ affinidi create project
-```
+Some of our components would also require you to incorporate our end-user notices into your terms and conditions.
 
-Note: When a project is created, its API keys are displayed only once. Full project details are stored locally in `~/.affinidi/credentials.json`. This file is deleted at the end of the authenticated session.
+### Is Affinidi CLI free for use?
 
-PROJECT FLAGS
+Affinidi CLI is free during the open beta phase, so come onboard and experiment with our tools and see what you can build! We may bill for certain components in the future, but we will inform you beforehand.
 
-```
-  -o, --output=(plaintext|json)   [default: plaintext] Formats output view
-```
+### Is there any limit or cap to my usage of the Affinidi CLI?
 
-To create a schema:
+We may from time to time impose limits on your use of the Affinidi CLI, such as limiting the number of API requests that you may make in a given duration. This is to ensure the smooth operation of the Affinidi CLI so that you and all our other users can have a pleasant experience as we continue to scale and improve the Affinidi CLI.
 
-```
- $ affinidi create schema [schemaName] [FLAGS]
-```
+### Do I need to provide you with anything?
 
-SCHEMA FLAGS
+From time to time, we may request certain information from you to ensure that you are complying with the [Terms of Use](https://www.affinidi.com/terms-of-use).
+
+### Can I share my developer’s account with others?
+
+When you create a developer’s account with us, we will issue you your private login credentials. Please do not share this with anyone else, as you would be responsible for activities that happen under your account. If you have friends who are interested, ask them to sign up – let's build together!
+
+### Telemetry
+
+Affinidi collects usage data to improve our products and services. For information on what data we collect and how we use your data, please refer to our [Privacy Policy](https://www.affinidi.com/privacy-policy).
+
+_Disclaimer:
+Please note that this FAQ is provided for informational purposes only and is not to be considered a legal document. For the legal terms and conditions governing your use of the Affinidi CLI, please refer to our [Terms of Use](https://www.affinidi.com/terms-of-use)._
+
+## All commands
+
+<!-- commands -->
+* [`affinidi autocomplete [SHELL]`](#affinidi-autocomplete-shell)
+* [`affinidi commands`](#affinidi-commands)
+* [`affinidi generate app`](#affinidi-generate-app)
+* [`affinidi help [COMMANDS]`](#affinidi-help-commands)
+* [`affinidi iam add-principal`](#affinidi-iam-add-principal)
+* [`affinidi iam get-policies`](#affinidi-iam-get-policies)
+* [`affinidi iam list-principals`](#affinidi-iam-list-principals)
+* [`affinidi iam remove-principal`](#affinidi-iam-remove-principal)
+* [`affinidi iam update-policies`](#affinidi-iam-update-policies)
+* [`affinidi login add-user-to-group`](#affinidi-login-add-user-to-group)
+* [`affinidi login create-config`](#affinidi-login-create-config)
+* [`affinidi login create-group`](#affinidi-login-create-group)
+* [`affinidi login delete-config`](#affinidi-login-delete-config)
+* [`affinidi login delete-group`](#affinidi-login-delete-group)
+* [`affinidi login get-config`](#affinidi-login-get-config)
+* [`affinidi login get-group`](#affinidi-login-get-group)
+* [`affinidi login list-configs`](#affinidi-login-list-configs)
+* [`affinidi login list-groups`](#affinidi-login-list-groups)
+* [`affinidi login list-users-in-group`](#affinidi-login-list-users-in-group)
+* [`affinidi login remove-user-from-group`](#affinidi-login-remove-user-from-group)
+* [`affinidi login update-config`](#affinidi-login-update-config)
+* [`affinidi project create-project`](#affinidi-project-create-project)
+* [`affinidi project get-active-project`](#affinidi-project-get-active-project)
+* [`affinidi project list-projects`](#affinidi-project-list-projects)
+* [`affinidi project select-project`](#affinidi-project-select-project)
+* [`affinidi search`](#affinidi-search)
+* [`affinidi start`](#affinidi-start)
+* [`affinidi stop`](#affinidi-stop)
+* [`affinidi token create-token`](#affinidi-token-create-token)
+* [`affinidi token delete-token`](#affinidi-token-delete-token)
+* [`affinidi token get-token`](#affinidi-token-get-token)
+* [`affinidi token list-tokens`](#affinidi-token-list-tokens)
+* [`affinidi token update-token`](#affinidi-token-update-token)
+
+## `affinidi autocomplete [SHELL]`
+
+display autocomplete installation instructions
 
 ```
-  -d, --description=<value>       (required) Description of schema
-  -o, --output=(plaintext|json)   [default: plaintext] Formats output view
-  -p, --public=(true|false)       [default: false] To specify if you want to create public or private schemas
-  -s, --source=<value>            (required) Path to the json file with schema properties
-```
+USAGE
+  $ affinidi autocomplete [SHELL] [-r]
+
+ARGUMENTS
+  SHELL  (zsh|bash|powershell) Shell type
+
+FLAGS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+
+DESCRIPTION
+  display autocomplete installation instructions
 
-Please see [How to structure a schema](#how-to-structure-a-schema) for guidance on how to create the _source_ file.
 EXAMPLES
+  $ affinidi autocomplete
 
-```
-$ affinidi create project "Example Project"
+  $ affinidi autocomplete bash
 
-$ affinidi create schema "Example Name" -d "An example description" -s "/exampleSchema.json"
-```
+  $ affinidi autocomplete zsh
 
-You can also see the help for the command in the CLI:
+  $ affinidi autocomplete powershell
 
-```
-$ affinidi create --help
-$ affinidi create project --help
-$ affinidi create schema --help
+  $ affinidi autocomplete --refresh-cache
 ```
 
-### **affinidi generate-application**
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v2.3.6/src/commands/autocomplete/index.ts)_
 
-Use this command to generate a privacy-preserving app. Please see [Affinidi Reference App](#reference-app) for more details.
+## `affinidi commands`
 
-USAGE
+list all the commands
 
 ```
-$ affinidi generate-application [-n <value>] [-u <health|education|ticketing|gaming|career>][-w]
-```
+USAGE
+  $ affinidi commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>] [--filter
+    <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]
 
 FLAGS
+  -h, --help         Show CLI help.
+  -x, --extended     show extra columns
+  --columns=<value>  only show provided columns (comma-separated)
+  --csv              output is csv format [alias: --output=csv]
+  --filter=<value>   filter property by partial string matching, ex: name=foo
+  --hidden           show hidden commands
+  --no-header        hide table header from output
+  --no-truncate      do not truncate output to fit screen
+  --output=<option>  output in a more machine friendly format
+                     <options: csv|json|yaml>
+  --sort=<value>     property to sort by (prepend '-' for descending)
+  --tree             show tree of commands
 
-```
--n, --name=<value>                                                  [default: my-app] Name of the application
--o, --output=(plaintext|json)                                       [default: plaintext] Override default output format view
--u, --use-case=(health|education|ticketing|gaming|career) [default: ticketing] Choose which app you want generate
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  list all the commands
 ```
 
-You can use this to generate the application with the default values:
+_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v2.2.25/src/commands/commands.ts)_
 
-```
-$ affinidi generate-application
-```
+## `affinidi generate app`
 
-EXAMPLES
+Clone a reference application and create Auth0 connection
 
 ```
-$ affinidi generate-application -n ExampleApp
+USAGE
+  $ affinidi generate app [--json] [--no-color] [-p <value>] [--force]
 
-$ affinidi generate-application -n ExampleApp -u health
+FLAGS
+  -p, --path=<value>  Relative or absolute path where reference application should be cloned into
+  --force             Override destination directory if exists
 
-$ affinidi generate-application -n ExampleApp -u gaming
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-You can also see the help for the command in the CLI:
+EXAMPLES
+  $ affinidi generate app
 
-```
-$ affinidi generate-application --help
+  $ affinidi generate app -p <PATH_WHERE_TO_CLONE_REFERENCE_APP>
+
+  $ affinidi generate app --path <PATH_WHERE_TO_CLONE_REFERENCE_APP> --force
 ```
 
-### **affinidi help**
+## `affinidi help [COMMANDS]`
 
-Display help for affinidi
+Display help for affinidi.
 
+```
 USAGE
+  $ affinidi help [COMMANDS] [-n]
 
-```
-affinidi help
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for affinidi.
 ```
 
-### **affinidi issue-vc**
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.18/src/commands/help.ts)_
 
-Issues a verifiable credential based on a given schema
+## `affinidi iam add-principal`
 
-USAGE
+Adds a principal (user or token) to the active project
 
 ```
-$ affinidi issue-vc [EMAIL] [FLAGS]
-```
+USAGE
+  $ affinidi iam add-principal [--json] [--no-color] [-i <value>] [-t machine_user|user]
 
 FLAGS
+  -i, --principal-id=<value>     ID of the principal
+  -t, --principal-type=<option>  [default: machine_user] Type of the principal
+                                 <options: machine_user|user>
 
-```
--b, --bulk            Defines that issuance happens in bulk
--d, --data=<value>    (required) The source file with credential data, either .json or .csv
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
--s, --schema=<value>  (required) Json schema url
--w, --wallet=<value>  [default: https://wallet.affinidi.com/claim] Configure your own wallet to store VCs
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
+
+DESCRIPTION
+  Adds a principal (user or token) to the active project
+
+  To change your active project, use command affinidi project select-project
 
 EXAMPLES
+  $ affinidi iam add-principal -i <uuid>
 
-```
-$ affinidi issue-vc example@email.com -s "https://example.org/exampleSchema.json" -d "/exampleCredential.json"
+  $ affinidi iam add-principal --principal-id <uuid> --principal-type machine_user
 
-$ affinidi issue-vc -s "https://example.org/exampleSchema.json" -d "/exampleCredential.csv" -b
+FLAG DESCRIPTIONS
+  -i, --principal-id=<value>  ID of the principal
 
+    Get a list of possible IDs with command affinidi token list-tokens
 ```
 
-You can also see the help for the command in the CLI:
+## `affinidi iam get-policies`
+
+Gets the policies of a principal (user or token)
 
 ```
-$ affinidi issue-vc --help
-```
+USAGE
+  $ affinidi iam get-policies [--json] [--no-color] [-i <value>] [-t machine_user|user]
 
-### **affinidi list**
+FLAGS
+  -i, --principal-id=<value>     ID of the principal
+  -t, --principal-type=<option>  [default: machine_user] Type of the principal
+                                 <options: machine_user|user>
 
-Use the list command to display resources that you have created or are available.
-The current types of resources are:
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-- schemas
-- projects
+DESCRIPTION
+  Gets the policies of a principal (user or token)
 
-USAGE
+  Make sure the principal you are working with is part of the active project
+  Use command affinidi project select-project to change your active project
 
-```
-$ affinidi list [SUBCOMMAND] [ARGS...] [FLAGS]
-```
+EXAMPLES
+  $ affinidi iam get-policies -i <uuid>
 
-SUBCOMMANDS
+  $ affinidi iam get-policies --principal-id <uuid> --principal-type machine_user
 
-```
-projects          Shows you the list of your projects
-schemas           Shows a list of available schemas
+FLAG DESCRIPTIONS
+  -i, --principal-id=<value>  ID of the principal
+
+    Get a list of possible IDs with command affinidi token list-tokens
 ```
 
-FLAGS for project listing
+## `affinidi iam list-principals`
+
+Lists the principals (users and tokens) in the active project
 
 ```
--l, --limit=<value>                           [default: 10] Maximum number of projects which will be listed
--o, --output=(json|table|csv)  [default: json] Project listing output format
--s, --skip=<value>                            Index into projects list from which to start the listing
-```
+USAGE
+  $ affinidi iam list-principals [--json] [--no-color]
 
-FLAGS for schema listing
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-```
--c, --scope=(default|public|unlisted)  [default: default] The type of scope
--l, --limit=<value>                    [default: 10] The number of schemas to display
--o, --output=(json|table|csv)          [default: json] The type of output
--p, --public=(true|false)              [default: true] To specify if you want to get public or private schemas
--s, --skip=<value>                     The number of schemas to skip
--x, --extended                         show extra columns
---columns=<value>                      only show provided columns (comma-separated)
---csv                                  output is csv format [alias: --output=csv]
---filter=<value>                       filter property by partial string matching, ex: name=foo
---no-header                            hide table header from output
---no-truncate                          do not truncate output to fit screen
---sort=<value>                         property to sort by (prepend '-' for descending)
-```
+DESCRIPTION
+  Lists the principals (users and tokens) in the active project
 
-EXAMPLES
+  To change your active project, use command affinidi project select-project
 
+EXAMPLES
+  $ affinidi iam list-principals
 ```
-    $ affinidi list projects
 
-    $ affinidi list schemas
-```
+## `affinidi iam remove-principal`
 
-You can also see the help for the command in the CLI:
+Removes a principal (user or token) from the active project
 
 ```
-$ affinidi list --help
-$ affinidi list projects --help
-$ affinidi list schemas --help
-```
+USAGE
+  $ affinidi iam remove-principal [--json] [--no-color] [-i <value>] [-t machine_user|user]
 
-### **affinidi login**
+FLAGS
+  -i, --principal-id=<value>     ID of the principal
+  -t, --principal-type=<option>  [default: machine_user] Type of the principal
+                                 <options: machine_user|user>
 
-Log in with your email address to use Affinidi privacy-preserving services. You will receive a confirmation code via email, which you will need to complete the authentication.
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-USAGE
+DESCRIPTION
+  Removes a principal (user or token) from the active project
 
-```
-$ affinidi login [EMAIL]
-```
+  To change your active project, use command affinidi project select-project
+
+EXAMPLES
+  $ affinidi iam remove-principal -i <uuid>
 
-You can also simply type this and follow the prompts:
+  $ affinidi iam remove-principal --principal-id <uuid> --principal-type machine_user
 
+FLAG DESCRIPTIONS
+  -i, --principal-id=<value>  ID of the principal
+
+    Get a list of possible IDs with command affinidi token list-tokens
 ```
-$ affinidi login
+
+## `affinidi iam update-policies`
+
+Updates the policies of a principal (user or token) in the active project
+
 ```
+USAGE
+  $ affinidi iam update-policies [--json] [--no-color] [-i <value>] [-t machine_user|user] [-f <value>]
 
 FLAGS
+  -f, --file=<value>             Location of a json file containing principal policies
+  -i, --principal-id=<value>     ID of the principal
+  -t, --principal-type=<option>  [default: machine_user] Type of the principal
+                                 <options: machine_user|user>
 
-```
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-You can also see the help for the command in the CLI:
+DESCRIPTION
+  Updates the policies of a principal (user or token) in the active project
 
-```
-$ affinidi login --help
-```
+  Make sure the principal you are working with is part of the active project
+  Use command affinidi project select-project to change your active project
 
-### **affinidi logout**
+EXAMPLES
+  $ affinidi iam update-policies -i <uuid>
 
-Use this command to end your affinidi session
+  $ affinidi iam update-policies --principal-id <uuid> --principal-type machine_user --file policies.json
 
-USAGE
+FLAG DESCRIPTIONS
+  -i, --principal-id=<value>  ID of the principal
 
-```
-$ affinidi logout
+    Get a list of possible IDs with command affinidi token list-tokens
 ```
 
-You can also see the help for the command in the CLI:
+## `affinidi login add-user-to-group`
+
+Adds a user to a user group
 
 ```
-affinidi logout --help
-```
+USAGE
+  $ affinidi login add-user-to-group [--json] [--no-color] [--group-name <value>] [--user-sub <value>]
 
 FLAGS
+  --group-name=<value>  Name of the user group
+  --user-sub=<value>    Subject of the user. Currently the user's DID is supported.
 
-```
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
+
+EXAMPLES
+  $ affinidi login add-user-to-group --group-name my_group --user-sub did:key:12345
 ```
 
-### **affinidi rename project**
+## `affinidi login create-config`
 
-Use this command to change the name of an existing project
+Creates a login configuration in your active project
 
+```
 USAGE
+  $ affinidi login create-config [--json] [--no-color] [-f <value> | -n <value> | -u <value> |
+    --token-endpoint-auth-method client_secret_basic|client_secret_post|none | --claim-format array|map | --client-name
+    <value> | --client-origin <value> | --client-logo <value>]
+
+FLAGS
+  -f, --file=<value>                     Location of a json file containing login configuration data
+  -n, --name=<value>                     Name of the login configuration
+  -u, --redirect-uris=<value>            OAuth 2.0 redirect URIs, separated by space
+  --claim-format=<option>                ID token claims output format. Defaults to array
+                                         <options: array|map>
+  --client-logo=<value>                  URL of a logo for the client, displayed in the consent page
+  --client-name=<value>                  Name of the client, displayed in the consent page
+  --client-origin=<value>                Origin of the client, displayed in the consent page
+  --token-endpoint-auth-method=<option>  Client authentication method for the token endpoint. Defaults to
+                                         client_secret_post
+                                         <options: client_secret_basic|client_secret_post|none>
+
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
+
+EXAMPLES
+  $ affinidi login create-config
 
+  $ affinidi login create-config -f loginConfig.json
+
+  $ affinidi login create-config -n MyLoginConfig -u http://localhost:8080/callback
+
+  $ affinidi login create-config --name "My Login Config" --redirect-uris "https://my-fancy-project.eu.auth0.com/login/callback http://localhost:8080/callback" --token-endpoint-auth-method client_secret_post --claim-format array --scope "my_user_group my_other_group" --client-name "My App Name" --client-origin http://localhost:8080 --client-logo http://localhost:8080/logo
+
+FLAG DESCRIPTIONS
+  --token-endpoint-auth-method=client_secret_basic|client_secret_post|none
+
+    Client authentication method for the token endpoint. Defaults to client_secret_post
+
+    The options are:
+    client_secret_post: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body
+    client_secret_basic: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP
+    Authorization header
+    none: For public clients (native/mobile apps) which can not have a secret
 ```
-$ affinidi rename project [<project-id>] [FLAGS]
+
+## `affinidi login create-group`
+
+Create a user group in your active project
+
 ```
+USAGE
+  $ affinidi login create-group [--json] [--no-color] [-n <value>]
 
 FLAGS
+  -n, --name=<value>  Name of the user group, that follows url-friendly pattern ^[a-z_]+$
 
-```
--n, --name=<value>  (required) The new name of the project
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
 EXAMPLES
+  $ affinidi login create-group -n my_new_group
 
-```
-$ affinidi rename project example-id -n "New Name"
+  $ affinidi login create-group --name my_new_group
 ```
 
-You can also see the help for the command in the CLI:
+## `affinidi login delete-config`
 
-```
-$ affinidi rename project --help
-```
+Deletes a login configuration from your active project
 
-### **affinidi show**
+```
+USAGE
+  $ affinidi login delete-config [--json] [--no-color] [-i <value>]
 
-This command displays the details of a resource. The current available resource types are:
+FLAGS
+  -i, --id=<value>  ID of the login configuration
 
-- project
-- schema
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-USAGE
+EXAMPLES
+  $ affinidi login delete-config -i <value>
 
-```
-$ affinidi show [SUBCOMMAND] [ARG...] [FLAGS]
+  $ affinidi login delete-config --id <value>
 ```
 
-SUBCOMMANDS
+## `affinidi login delete-group`
+
+Deletes a user group from your active project
 
 ```
-project         Shows information about a given project
-schema          Shows the details of a schema
-user            Shows info about logged-in user
-```
+USAGE
+  $ affinidi login delete-group [--json] [--no-color] [-n <value>]
 
-PROJECT FLAGS
+FLAGS
+  -n, --name=<value>  Name of the user group
 
-```
--a, --active                    Set to show the active project
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-To show a project:
+EXAMPLES
+  $ affinidi login delete-group -n my_group
 
-```
-$ affinidi show [<project-id>]
+  $ affinidi login delete-group --name my_group
 ```
 
-if you simply type this, the CLI will prompt you to choose from a list of available projects:
+## `affinidi login get-config`
+
+Gets the details of a login configuration in your active project
 
 ```
-$ affinidi show project
-```
+USAGE
+  $ affinidi login get-config [--json] [--no-color] [-i <value>]
 
-SCHEMA FLAGS
+FLAGS
+  -i, --id=<value>  ID of the login configuration
 
-```
--o, --output=(plaintext|json)  Set this flag to override the default plain text format view
--s, --show=(info|json|jsonld)  [default: info] The details of the schema to show
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-To show a schema:
+EXAMPLES
+  $ affinidi login get-config -i <value>
 
-```
-$ affinidi show schema [<schema-id>] [--output json]
+  $ affinidi login get-config --id <value>
 ```
 
-USER FLAGS
+## `affinidi login get-group`
+
+Gets the details of a user group
 
 ```
--o, --output=(plaintext|json)  Set this flag to override the default plain text format view
-```
+USAGE
+  $ affinidi login get-group [--json] [--no-color] [-n <value>]
 
-To show info of logged in user:
+FLAGS
+  -n, --name=<value>  Name of the user group
 
-```
-$ affinidi show user
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
 EXAMPLES
+  $ affinidi login get-group -n my_group
 
+  $ affinidi login get-group --name my_group
 ```
-$ affinidi show project example-id
 
-$ affinidi show schema example-id
+## `affinidi login list-configs`
+
+Lists login configurations in your active project
 
-$ affinidi show user
 ```
+USAGE
+  $ affinidi login list-configs [--json] [--no-color]
 
-You can also see the help for the command in the CLI:
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-```
-$ affinidi show --help
-$ affinidi show project --help
-$ affinidi show schema --help
-$ affinidi show user --help
+EXAMPLES
+  $ affinidi login list-configs
 ```
 
-### **affinidi sign-up**
+## `affinidi login list-groups`
 
-Create an Affinidi account with this command to use our privacy-preserving tools. You will need your email address, and then confirm the authentication with the code sent to your email. After confirming the authentication a default project will be created so you can start using Affinidi services right away.
+Lists user groups in your active project
 
+```
 USAGE
+  $ affinidi login list-groups [--json] [--no-color]
 
-```
-$ affinidi sign-up [EMAIL]
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
+
+EXAMPLES
+  $ affinidi login list-groups
 ```
 
-You can also simply type this and follow the prompts:
+## `affinidi login list-users-in-group`
+
+Use this command to list users in the user group
 
 ```
-$ affinidi sign-up
-```
+USAGE
+  $ affinidi login list-users-in-group [--json] [--no-color] [--group-name <value>]
 
-You can also see the help for the command in the CLI:
+FLAGS
+  --group-name=<value>  Name of the user group
 
-```
-$ affinidi sign-up --help
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-### **affinidi use**
+EXAMPLES
+  $ affinidi login list-users-in-group --group-name my_group
+```
 
-The Use command lets you choose and activate a project. An active project is a prerequisite for executing most commands.
+## `affinidi login remove-user-from-group`
 
-USAGE
+Removes a user from a user group
 
 ```
-$ affinidi use project [<project-id>] [FLAGS]
-```
+USAGE
+  $ affinidi login remove-user-from-group [--json] [--no-color] [--group-name <value>] [--user-mapping-id <value>]
 
 FLAGS
+  --group-name=<value>       Name of the user group
+  --user-mapping-id=<value>  ID of the user mapping record
 
-```
--o, --output=(plaintext|json)   [default: plaintext] Formats output view of the chosen project's details
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
 EXAMPLES
-
-```
-    $ affinidi use project example-id
+  $ affinidi login remove-user-from-group --group-name my_group --user-mapping-id <value>
 ```
 
-You can also see the help for the command in the CLI:
+## `affinidi login update-config`
+
+Updates a login configuration
 
 ```
-$ affinidi use --help
-$ affinidi use project --help
-```
+USAGE
+  $ affinidi login update-config [--json] [--no-color] [-i <value>] [-f <value> | -n <value> | -u <value> |
+    --token-endpoint-auth-method client_secret_basic|client_secret_post|none | --client-name <value> | --client-origin
+    <value> | --client-logo <value>]
 
-### **affinidi verify-vc**
+FLAGS
+  -f, --file=<value>                     Location of a json file containing login configuration data
+  -i, --id=<value>                       ID of the login configuration
+  -n, --name=<value>                     Name of the login configuration
+  -u, --redirect-uris=<value>            OAuth 2.0 redirect URIs, separated by space
+  --client-logo=<value>                  URL of a logo for the client, displayed in the consent page
+  --client-name=<value>                  Name of the client, displayed in the consent page
+  --client-origin=<value>                Origin of the client, displayed in the consent page
+  --token-endpoint-auth-method=<option>  Client authentication method for the token endpoint. Defaults to
+                                         client_secret_post
+                                         <options: client_secret_basic|client_secret_post|none>
+
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-Verifies a verifiable credential
+EXAMPLES
+  $ affinidi login update-config --id <value> -f loginConfig.json
 
-USAGE
+  $ affinidi login update-config --id <value> -u http://localhost:8080/callback
+
+  $ affinidi login update-config --id <value> --name "My Login Config" --redirect-uris "https://my-fancy-project.eu.auth0.com/login/callback http://localhost:8080/callback" --token-endpoint-auth-method client_secret_post --client-name "My App Name" --client-origin http://localhost:8080 --client-logo http://localhost:8080/logo
+
+FLAG DESCRIPTIONS
+  --token-endpoint-auth-method=client_secret_basic|client_secret_post|none
 
+    Client authentication method for the token endpoint. Defaults to client_secret_post
+
+    The options are:
+    client_secret_post: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body
+    client_secret_basic: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP
+    Authorization header
+    none: For public clients (native/mobile apps) which can not have a secret
 ```
-$ affinidi verify-vc -d <value>
+
+## `affinidi project create-project`
+
+Creates a project
+
 ```
+USAGE
+  $ affinidi project create-project [--json] [--no-color] [-n <value>]
 
 FLAGS
+  -n, --name=<value>  Name of the project
 
-```
--d, --data=<value>  (required) Source json file with credentials to be verified
--o, --output=(plaintext|json)   [default: plaintext] Formats output view
-```
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
 EXAMPLES
+  $ affinidi project create-project -n MyProjectName
 
-```
-$ affinidi verify-vc -d "/exampleVc.json"
+  $ affinidi project create-project --name "My project name"
 ```
 
-You can also see the help for the command in the CLI:
+## `affinidi project get-active-project`
+
+Gets the current active project
 
 ```
-$ affinidi verify-vc --help
-```
+USAGE
+  $ affinidi project get-active-project [--json] [--no-color]
 
-### **affinidi start**
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-Also called `wizard`.
+EXAMPLES
+  $ affinidi project get-active-project
+```
 
-This command provides you with an end-to-end, step-by-step guide to the Affinidi CLI, with selectable options.
+## `affinidi project list-projects`
 
-You can imagine it like an installation wizard for an app on a desktop or a mobile-device.
+Lists your projects
 
-See documentation [here](./docs/wizard.md)
+```
+USAGE
+  $ affinidi project list-projects [--json] [--no-color]
 
-&nbsp;
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-&nbsp;
+EXAMPLES
+  $ affinidi project list-projects
+```
 
-#
+## `affinidi project select-project`
 
-## About Schemas and Verifiable Credentials
+Sets a project as the active project
 
-Schemas are representations of the properties that define a VC. They are a composite of [JSON Schema](https://json-schema.org/specification.html), [JSON-LD](https://www.w3.org/TR/json-ld11/) context and metadata (description, version and ownership). You can use Affinidi's [Schema Manager](https://affinidi-schema-manager.prod.affinity-project.org/api-docs) to find the right schema for your verifiable credential or to create a new one – either on the basis of an already existing schema,
-or completely from scratch.
+```
+USAGE
+  $ affinidi project select-project [--json] [--no-color] [-i <value>]
 
-### What is Affinidi's Schema Manager?
+FLAGS
+  -i, --project-id=<value>  ID of the project
 
-The Schema Manager provides URLs for two kinds of schema representations: JSON Schema and JSON-LD context.
-Any schema can be referenced in a verifiable credential or an application by these URLs. Before creating a new schema for your verifiable credentials, it is recommended to search for an existing one, which may fit your purpose. There are both a number of standard schemas and some user-generated schemas already available in the Schema Manager, and you can search for them by “Credential schema type”. That is why it is important to provide a meaningful and expressive type for your newly created schemas.
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-### How to structure a schema
+EXAMPLES
+  $ affinidi project select-project
 
-The JSON representation of a schema must follow this structure:
+  $ affinidi project select-project -i <project-id>
 
-```
-{
-  "type": "object",
-  "properties": {
-    "<propertyName>": {
-      "title": "<Property title>",
-      "type": "<Property type (see available attribites below)>",
-      "description": "<Property description>"
-    },
-    <other properties>
-  },
-  "required": [
-    <list of required properties>
-  ]
-}
+  $ affinidi project select-project --project-id <project-id>
 ```
 
-And here is an example of that structure used to represent a simple form with two fields (`First Name` and `Last Name`):
+## `affinidi search`
+
+Search for a command.
 
 ```
-{
-  "type": "object",
-  "properties": {
-    "firstName": {
-      "title": "First Name",
-      "type": "string",
-      "description": "First name of a customer"
-    },
-    "lastName": {
-      "title": "Last Name",
-      "type": "string",
-      "description": "Last name of a customer"
-    }
-  },
-  "required": [
-    "lastName"
-  ]
-}
-```
+USAGE
+  $ affinidi search
 
-### What attribute types are available?
-
-- Nested attribute – a container for attributes
-- DID – a decentralized identifier
-  - Example of VC value: "did:example:123"
-- Text – a string value
-  - Example of VC value: "my text"
-- URI – a link to a web resource
-  - Example of VC value: "http://ui.schema.affinidi.com/"
-- Date – a date (ISO 8601)
-  - Example of VC value: "2011-04-01"
-- DateTime – a specific point in time (ISO 8601)
-  - Example of VC value: "2011-05-08T19:30"
-- Number – a numerical value
-  - Example of VC value: 123.45
-- Boolean – a boolean value
-  - Example of VC value: true or false
-
-Example of schema source with all the types:
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "nestedType": {
-      "title": "nestedType",
-      "type": "object",
-      "description": "Field with nested attributes",
-      "properties": {
-        "nestedTextType": {
-          "title": "nestedTextType",
-          "type": "string",
-          "description": "Nested text field "
-        }
-      },
-      "required": []
-    },
-    "didType": {
-      "title": "didType",
-      "type": "string",
-      "format": "did",
-      "description": "DID attribute"
-    },
-    "testType": {
-      "title": "testType",
-      "type": "string",
-      "description": "Text attribute"
-    },
-    "uriType": {
-      "title": "uriType",
-      "type": "string",
-      "format": "uri",
-      "description": "URI attribute"
-    },
-    "dateType": {
-      "title": "dateType",
-      "type": "string",
-      "format": "date",
-      "description": "Date attribute"
-    },
-    "dateTimeType": {
-      "title": "dateTimeType",
-      "type": "string",
-      "format": "date-time",
-      "description": "DateTime attribute"
-    },
-    "numberType": {
-      "title": "numberType",
-      "type": "number",
-      "description": "Number attribute"
-    },
-    "booleanType": {
-      "title": "booleanType",
-      "type": "boolean",
-      "description": "Boolean attribute"
-    }
-  },
-  "required": []
-}
+DESCRIPTION
+  Search for a command.
+
+  Once you select a command, hit enter and it will show the help for that command.
 ```
 
-### How to create or find a schema
+_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v0.0.22/dist/commands/search.ts)_
 
-1. You can directly create a schema in the CLI with the [`create`](#affinidi-create) command or using the [Schema Manager API](https://affinidi-schema-manager.prod.affinity-project.org/api-docs/#/Schema/CreateSchema).
+## `affinidi start`
 
-2. You can list available schemas with the [`list`](#affinidi-list) command or search via the [Schema Manager API](https://affinidi-schema-manager.prod.affinity-project.org/api-docs/#/Schema/SearchSchemas) specifying `scope`, `type` or `authorDID`.
+Log in to Affinidi
 
-### What is the difference between a version and a revision?
+```
+USAGE
+  $ affinidi start [--json] [--no-color] [-i <value>]
 
-Essentially, all the revisions of the single version should be compatible with each other,
-whereas new versions could feature breaking changes, e.g. new mandatory fields. Currently, adherence to this principle is not enforced, but it is good to keep in mind when choosing between new version or revision for your forked schema.
+FLAGS
+  -i, --project-id=<value>  ID of the project to set as active
 
-### What does it mean to “publish as searchable schema”?
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-Schemas can be either public (visible and searchable for everyone ) or
-private (unlisted, visible and searchable only for you).
-When you “publish as searchable schema” (using flag `-p`), you make your schema public.
+EXAMPLES
+  $ affinidi start
+
+  $ affinidi start -i <project-id>
 
-It is important to remember, that versions and revisions of public and private
-(unlisted) schema are independent of each other,
-and are maintained by the system in parallel.
-However, you can always fork your private (unlisted) schema in order to make it public and vice versa.
+  $ affinidi start --project-id <project-id>
+```
 
-### How to structure a JSON file to issue a VC:
+_See code: [dist/commands/start.ts](https://github.com/affinidi/affinidi-cli/blob/v2.0.0-beta.76/dist/commands/start.ts)_
 
-The JSON file that is the source for the VC to be issued must follow the structure of the schema on which the VC is based. Use the properties of the schema's `credentialSubject` as the template for the new VC.
+## `affinidi stop`
 
-Example for [Event Eligibility Schema](https://schema.affinidi.com/EventElegibilityV1-0.json):
+Log out from Affinidi
 
 ```
-{
-    "date": "2031-12-11T11:15:00Z",
-    "place": "Awesome Location",
-    "eventName": "Name of Your Event",
-    "eventDescription": "Your Event Description",
-    "name": "Holder Name",
-    "email": "mail@example.com"
-}
+USAGE
+  $ affinidi stop [--json] [--no-color]
+
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
+
+EXAMPLES
+  $ affinidi stop
 ```
 
-&nbsp;
+_See code: [dist/commands/stop.ts](https://github.com/affinidi/affinidi-cli/blob/v2.0.0-beta.76/dist/commands/stop.ts)_
 
-&nbsp;
+## `affinidi token create-token`
 
-#
+Creates a Personal Access Token (PAT)
 
-## Feedback & Support
+```
+USAGE
+  $ affinidi token create-token [--json] [--no-color] [-n <value>] [-k <value>] [-f <value>] [--algorithm
+    RS256|RS512|ES256|ES512]
 
-Click [here](https://github.com/affinidi/affinidi-cli/issues) to create a ticket and we will get on it right away. If you are facing technical or other issues, you can reach out to us on [Discord](https://discord.com/invite/jx2hGBk5xE).
+FLAGS
+  -f, --public-key-file=<value>  Location of the public key PEM file
+  -k, --key-id=<value>           Identifier of the key (kid)
+  -n, --name=<value>             Name of the Personal Access Token, at least 8 chars long
+  --algorithm=<option>           [default: RS256] The specific cryptographic algorithm used with the key
+                                 <options: RS256|RS512|ES256|ES512>
 
-&nbsp;
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-## FAQ
+EXAMPLES
+  $ affinidi token create-token -n MyNewToken -k MyKeyID -f publicKey.pem
 
-### A note from Affinidi
+  $ affinidi token create-token --name "My new token" --key-id MyKeyID --public-key-file publicKey.pem --algorithm RS256
+```
 
-Affinidi Developer Tools are currently in the open beta phase and we are refining our product every day. The Affinidi Developer Tools may be incomplete and may contain errors – they may be unstable and may cause a loss of functionality and data. Use of the Affinidi Developer Tools will be at your own risk. As our engineers seek to improve our platform, we would not have the resources to provide any maintenance or tech support at this time. Please bear with us as we continue to improve the platform.
+## `affinidi token delete-token`
 
-### What can I develop?
+Deletes a Personal Access Token (PAT)
 
-You are only limited by your imagination! Affinidi Developer Tools is a toolbox with which you can build software applications for personal or commercial use.
+```
+USAGE
+  $ affinidi token delete-token [--json] [--no-color] [-i <value>]
 
-### Is there anything I should not develop?
+FLAGS
+  -i, --token-id=<value>  ID of the Personal Access Token
 
-We only provide the tools - how you use them is largely up to you. We have no control over what you develop with our tools - but please use our tools responsibly!
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-We hope that you would not develop anything that contravenes any applicable laws or regulations. Your projects should also not infringe on Affinidi’s or any third party’s intellectual property (for instance, misusing other parties’ data, code, logos, etc).
+EXAMPLES
+  $ affinidi token delete-token -i <uuid>
 
-### What responsibilities do I have to my end-users?
+  $ affinidi token delete-token --token-id <uuid>
+```
 
-Please ensure that you have in place your own terms and conditions, privacy policies, and other safeguards to ensure that the projects you build are secure for your end users.
+## `affinidi token get-token`
 
-If you are processing personal data, please protect the privacy and other legal rights of your end-users and store their personal or sensitive information securely.
+Gets the details of a Personal Access Token (PAT)
 
-Some of our components would also require you to incorporate our end-user notices into your terms and conditions.
+```
+USAGE
+  $ affinidi token get-token [--json] [--no-color] [-i <value>]
 
-### Are Affinidi Developer Tools free for use?
+FLAGS
+  -i, --token-id=<value>  ID of the Personal Access Token
 
-Affinidi Developer Tools are free during the open beta phase, so come onboard and experiment with our tools and see what you can build! We may bill for certain components in the future, but we will inform you beforehand.
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-### Is there any limit or cap to my usage of the Affinidi Developer Tools?
+EXAMPLES
+  $ affinidi token get-token -i <uuid>
 
-We may from time to time impose limits on your use of the Affinidi Developer Tools, such as limiting the number of API requests that you may make in a given duration. This is to ensure the smooth operation of the Affinidi Developer Tools so that you and all our other users can have a pleasant experience as we continue to scale and improve the Affinidi Developer Tools.
+  $ affinidi token get-token --token-id <uuid>
+```
 
-### Do I need to provide you with anything?
+## `affinidi token list-tokens`
 
-From time to time, we may request certain information from you to ensure that you are complying with the [Terms of Use](https://build.affinidi.com/dev-tools/terms-of-use.pdf).
+Lists your Personal Access Tokens (PATs)
 
-### Can I share my developer’s account with others?
+```
+USAGE
+  $ affinidi token list-tokens [--json] [--no-color]
 
-When you create a developer’s account with us, we will issue you your private login credentials. Please do not share this with anyone else, as you would be responsible for activities that happen under your account. If you have friends who are interested, ask them to sign up – let's build together!
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
 
-### Telemetry
+EXAMPLES
+  $ affinidi token list-tokens
+```
+
+## `affinidi token update-token`
+
+Updates a Personal Access Token (PAT)
 
-Affinidi collects usage data to improve our products and services. For information on what data we collect and how we use your data, please refer to our [Privacy Policy](https://build.affinidi.com/dev-tools/privacy-policy.pdf).
+```
+USAGE
+  $ affinidi token update-token [--json] [--no-color] [-i <value>] [-n <value>] [-k <value>] [-f <value>] [--algorithm
+    RS256|RS512|ES256|ES512]
 
-Disclaimer:
-Please note that this FAQ is provided for informational purposes only and is not to be considered a legal document. For the legal terms and conditions governing your use of the Affinidi Developer Tools, please refer to our [Terms of Use](https://build.affinidi.com/dev-tools/terms-of-use.pdf).
+FLAGS
+  -f, --public-key-file=<value>  Location of the public key PEM file
+  -i, --token-id=<value>         ID of the Personal Access Token
+  -k, --key-id=<value>           Identifier of the key (kid)
+  -n, --name=<value>             Name of the Personal Access Token, at least 8 chars long
+  --algorithm=<option>           [default: RS256] The specific cryptographic algorithm used with the key
+                                 <options: RS256|RS512|ES256|ES512>
+
+GLOBAL FLAGS
+  --json      Format output as json.
+  --no-color  Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
+
+EXAMPLES
+  $ affinidi token update-token -i <uuid> -n MyNewToken -k MyKeyID -f publicKey.pem
+
+  $ affinidi token update-token --token-id <uuid> --name "My new token" --key-id "My key ID" --public-key-file publicKey.pem --algorithm RS256
+```
+<!-- commandsstop -->