Skip to Content
Installation

Installation

Getting started with Nanokit is straightforward. The platform is primarily managed through the nkapp CLI, which acts as the orchestrator for your local and remote environments.

Prerequisites

Before installing Nanokit, ensure your machine meets the following requirements:

  • Node.js: v18.0 or higher.
  • Docker: Desktop or Engine (running and accessible).
  • Git: For repository-based orchestration.

[!NOTE] On Linux, ensure your user is part of the docker group to allow the CLI to interact with the Docker socket without sudo.

Installing the CLI

Nanokit is distributed via NPM as @nkapp/cli. You can install it globally using your preferred package manager:

# Using NPM
npm install -g @nkapp/cli
 
# Using Yarn
yarn global add @nkapp/cli
 
# Using PNPM
pnpm add -g @nkapp/cli

Verifying the Installation

Once installed, verify that the CLI is correctly configured by checking its version. The global command remains nkapp:

nkapp --version

You should see an output similar to: Nanokit CLI v1.0.0 (Stabilized)

Environment Setup

Nanokit uses a global state directory at ~/.nanokit to manage clusters, certificates, and multi-repo discovery. This directory is created automatically upon your first command execution.

Permissions

If you are deploying to remote servers via SSH, ensure your SSH agent is running and your identity is added:

ssh-add ~/.ssh/id_rsa

Next: Getting Started

RequirementsGetting Started