Installation Guide

Learn how to install and configure NELGIFKA on your local machine or production environment.

⚙️ Begin Installation

Getting Started

1

Prerequisites

Ensure you have the following installed:

Node.js 16.14.0 or higher
npm 8.5.0 or equivalent
Git (optional but recommended)

2

Install CLI


npm install @nelgifka/cli -g

This installs the NELGIFKA command-line interface globally on your system.

3

Create Project


nelgifka create my-project

This generates a new project scaffold with all necessary configuration files.

Advanced Options

Docker Setup


docker run -d --name nelgifka \
  -p 3000:3000 \
  -e NELGIFKA_API_KEY=your_key \
  nelgifka/project:latest

Deploy NELGIFKA using Docker with environment variables for configuration.

✅ Isolated dependencies
✅ Easy scaling
✅ Production-ready

Alternative Installers

Homebrew (macOS)

$ brew install nelgifka

Linux Deb Package

$ sudo dpkg -i nelgifka_1.0.0.deb

Verify Installation

Run Diagnostic Test


                        nelgifka verify --full

This will run a full diagnostic suite to confirm all components are working properly.

{
  "status": "OK",
  "version": "1.2.3",
  "validations": {
    "api_connectivity": "✅",
    "dependencies": "✅",
    "permissions": "✅"
  },
  "timestamp": "2025-09-03T12:34:56Z"
}

Common Issues

Error: Module not found

Ensure Node.js is properly installed and available in your PATH.

Try clearing npm cache:

npm cache clean --force

Warning: Version mismatch

Make sure all dependencies are up to date.

Run upgrade command:

nelgifka update --all