Skip to content

Installation Guide

Welcome to the KaspaAPI Module! Follow this guide to install the module from GitHub and set it up in your PowerShell environment.

Requirements

Before you begin, ensure your environment meets the following requirements:

  • PowerShell Version: 5.1 or later.
  • Git: Required to clone the repository.
  • Internet Access: Needed to download the repository.

Installation Steps

Method 1: Install via GitHub

  1. Clone the Repository:

  2. Open your terminal (or PowerShell) and run the following command to clone the repository:

    powershell git clone https://github.com/BabyKonanCoin/KaspaAPI.git

  3. Navigate to the Module Folder:

  4. Change your directory to the location of the cloned repository:

    powershell cd KaspaAPI/KaspaAPI

  5. Import the Module:

  6. Import the module into your PowerShell session:

    powershell Import-Module .\KaspaAPI.psd1

  7. Verify the Installation:

  8. Check if the module is loaded by running:

    powershell Get-Module -Name KaspaAPI

Method 2: Copy the Module to PowerShell Modules Folder

  1. Clone the Repository (as shown above).

  2. Move the Module Folder:

  3. Copy the KaspaAPI folder (containing KaspaAPI.psd1) to your PowerShell modules directory:

    powershell $Destination = "$($env:USERPROFILE)\Documents\WindowsPowerShell\Modules\KaspaAPI" Copy-Item -Path ".\KaspaAPI" -Destination $Destination -Recurse

  4. Import the Module:

  5. Import the module into your session:

    powershell Import-Module KaspaAPI

  6. Verify the Installation:

  7. Ensure the module is available globally:

    powershell Get-Module -ListAvailable -Name KaspaAPI

Troubleshooting Installation

  1. Permission Issues:

  2. If you encounter permission errors, try running PowerShell as an administrator.

  3. Missing Dependencies:

  4. Ensure that you’ve installed all required dependencies for PowerShell and Git.

  5. Git Not Installed:

  6. If Git is not installed, download and install it from https://git-scm.com/.

Next Steps

Once installed, proceed to the Configuration Guide to set up the module for your workflow.

For more details, visit the KaspaAPI GitHub Repository.