Skip to main content
Quick Start Guide to Begin Using the QuikDB BETA SDK

​
Step 1: Configure Your Environment

Before installing the SDK, you need to configure your environment based on how you authenticated with QuikDB. Follow the appropriate command below:
Note: The identity is automatically generated by the system when you log in using Internet Identity.
Parameters:
  • -u, --username <username>: Your chosen username.
  • -e, --email <email>: Your email address (for Email & Password authentication).
  • -i, --identity <identity>: Your Internet Identity identifier (for Internet Identity authentication).
Example: 
# Using Email & Password
quikdb config -u johndoe -e johndoe@example.com

# Using Internet Identity
quikdb config -u johndoe -i abcdefghijklmnopqrstuvwxyz

​
Step 2: Install the QuikDB SDK

After configuring your environment, proceed to install the QuikDB SDK. 
# run this command on your device before installing within an application
quikdb install

​
Step 3: Verify Installation

Ensure that the SDK has been installed correctly by checking its version: 
quikdb --version
Expected Output: 
quikdb-cli-beta version 1.0.0