Manual - Configuring Nectar Project with Developer Machine

This guide explains how to configure the Nectar Project Module with your developer machine using Chordium.

---

Prerequisites

Before you begin, make sure you have:

• Nectar user credentials with read permission to the Project Module.
• Basic Auth details for the Nectar account.
• Node.js version 20 or higher

  Tip: We recommend using nvm to manage Node versions.

• Git Personal Access Token (PAT) with Package Read Access
• Install Chordium

---

Setting up lenscloud (Chordium CLI) locally

Chordium is officially published, you may see the package in chordium.

Since @lmnaslimited/lenscloud is hosted on GitHub Packages, you need to explicitly tell npm to use the GitHub registry for that scope.

Step-1 : Create (or update) a .npmrc file in your home directory

@lmnaslimited:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=<YOUR_TOKEN>

Replace <YOUR_TOKEN> with Git PAT

Step-2 : Run the below command in the Terminal

npm install @lmnaslimited/lenscloud@latest

---

Running the Configuration Command

To start the setup process, open a terminal and run:

lenscloud config

You’ll see a menu like this:

? What do you want to do? (Use arrow keys)
❯ Set/Edit Configuration
  View Configuration
  Delete Configuration

🔹 Option 1: Set/Edit Configuration

Choose this option to create or update your configuration.

Example:

? What do you want to do? Set/Edit Configuration
? Enter the Nectar Application URL: https://nectar.lmnas.com
? Enter API Access Key: *****************
? Enter Git Personal Access Token: ******************************
✔ Configuration saved successfully!

What each input means:

• Nectar Application URL – The web address of your Nectar instance.

• Nectar User’s Basic Auth – Got using API Key and API Secret.

• Git Personal Access Token – Used for Git operations (create one with repo permissions if working with private repos).

🔹 Option 2: View Configuration

Choose this to see your current settings.

Example:

? What do you want to do? View Configuration
{
  "project_management_site": "https://nectar.lmnas.com",
  "api_key": "********",
  "git_pat": "********"
}

Note: Sensitive values like API keys and tokens will be masked in the display.

🔹 Option 3: Delete Configuration

Choose this to remove your saved settings and start fresh.

Example:

? What do you want to do? Delete Configuration
✔ Configuration deleted successfully!

Example Full Setup Flow

1. Open a terminal.

2. Run:

lenscloud config

3. Select Set/Edit Configuration.

4. Enter your Nectar details and Git token.

5. Once saved, try:

lenscloud project use

If everything is configured correctly, you’ll see a list of your Nectar projects ready to sync.