Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 1.46 KB

install.md

File metadata and controls

48 lines (36 loc) · 1.46 KB

Installation Guide for kpt

This guide will help you install the kpt command on your system. The kpt command will run the main.ts script located in the cloned repository using Deno.

What the Installation Does

  1. Checks for Deno Installation: The script first checks if Deno is installed on your system. If not, it installs Deno.
  2. Sets Up the kpt Command:
    • Unix-based Systems: The script creates a symbolic link to the kpt.sh script in /usr/local/bin, making the kpt command globally available.
  3. Ensures the kpt.sh Script is Executable: The script ensures that the kpt.sh script has execute permissions.

Warning

⚠️ Warning: Do not move the cloned Git repository after running the installation script. The installation creates a symbolic link to the kpt.sh script. Moving the repository will break the link and the kpt command will no longer work.

Installation Steps

Unix-based Systems

  1. Ensure you have git installed.
  2. Clone the repository:
git clone https://github.com/arne-vl/kpt.git
  1. Run the installation script:
cd kpt/installers
chmod +x install.sh && ./install.sh

Verifying the Installation

After running the installation script, you can verify the installation by running:

kpt --version

or

kpt -v

Uninstall

To uninstall the kpt command, remove the symbolic link created during installation:

Unix-based Systems

sudo rm /usr/local/bin/kpt