Affinidi CLI

Affinidi CLI is a developer tool to easily manage your projects and integrate with Affinidi services using the command line. It empowers developers to use simple commands to improve developer experience when interacting with our different services.

Affinidi CLI is an open-source tool, and you can access the GitHub repository here .

Before you begin

1. Set up Affinidi Vault account. Follow the guide below if you haven’t set it up yet.

Set up Affinidi Vault

1. Set up an Affinidi Vault account using the web app or install the mobile app .

The same installation steps for mobile app.

2. Click on Start if you are creating a new account, or click on Restore from Backup if you have an existing backup of your Affinidi Vault.

Use this guide to learn how to migrate your existing Affinidi Vault account.

3. Secure your Vault by providing a passphrase. Use this passphrase to unlock your Vault.

3. Provide your Email Address to verify with OTP.

After successfully providing the OTP, you are redirected to your Affinidi Vault dashboard.

Vault Passphrase

Remember to keep your passphrase in a secure location since it cannot be retrieved if forgotten, even with your backup. If you forget it, you must setup a new Vault.

2. Install NodeJS v18 or higher on your machine.

3. Install Git to generate a reference app using affinidi generate app command.

Installation

How do I use Affinidi CLI?

Accessing most Affinidi CLI features, like creating a Login Configuration, requires you to authenticate to Affinidi using Affinidi Vault. To do this, you can execute the following command:

affinidi start

If you received a session expired error, just run the same command to refresh your session.

Understanding commands

Commands in Affinidi CLI have the following structure:

affinidi <topic> <command> [flags]

1. All commands start with the keyword affinidi.
2. Topics typically correspond to Affinidi services or domains.
3. Commands correspond to the actions to perform.
4. Flags are a way to provide the parameters required by the command.
5. Use affinidi help <topic|command> to show the helpful details.

Available commands

Explore the Affinidi CLI topics to manage your projects, including Login Configurations to integrate Affinidi Login into your application.

Below are some of the useful commands available to access Affinidi services.

    affinidi start

affinidi  start [--json] [--no-color] [--no-input]

affinidi  start

    affinidi stop

affinidi  stop [--json] [--no-color] [--no-input]

affinidi  stop

    affinidi whoami

affinidi  whoami [--json] [--no-color] [--no-input]

affinidi  whoami

    affinidi help

affinidi  help [COMMANDS] [-n]

    affinidi search

affinidi  search

    affinidi commands

affinidi  commands [--json] [-h] [--hidden] [--tree] [--columns [value] | -x] [--sort [value]] [--filter	 [value]] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

    affinidi autocomplete

affinidi  autocomplete [SHELL] [-r]

affinidi  autocomplete

affinidi autocomplete bash

affinidi autocomplete zsh

affinidi autocomplete powershell

affinidi autocomplete --refresh-cache

Help

All commands and topics have a help document with usage, descriptions, flags and examples.

View it with the help flag: affinidi login create-config --help

With the help root command: affinidi help login create-config

Or by searching and selecting a command: affinidi search

Flags

All commands have some global flags at their disposal.

--help Prints the command’s help information.

--json Enforce printing the output in json format. Useful for programmatic usage of CLI.

--no-color Disables color in the output. Useful if you have trouble distinguishing colors.

--no-input Disables all the interactive prompts. Useful for automation anc ci.

You can input flags in multiple ways. All of the following will work:

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

Active Project

Affinidi CLI introduces a local concept of “Active Project” for convenience. Commands under the login and iam topics perform actions under the active 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.

To check what is the current active project use the command affinidi project get-active-project

To switch the active project use the command affinidi project select-project

Session and Configuration Files

When you authenticate to Affinidi with affinidi start the CLI will create a folder with a credentials file in your home directory.

~/.affinidi/credentials-v2.json - Stores your current session credentials. Keep it secret as this allows you to call Affinidi services.

When you run affinidi stop your session information is deleted.

Explore CLI Topics and Commands