Introduction

Nanokit is a next-generation orchestration platform designed to simplify the deployment and management of distributed applications. It bridges the gap between local development and complex multi-environment cloud deployments with a focus on Zero-Config and Developer Experience.

Why Nanokit?

In a world of complex Kubernetes manifests and opaque cloud consoles, Nanokit provides a clear, declarative, and high-performance alternative.

🚀 Full Parity: Work on Local, Staging, and Production with the exact same configuration.
🛠️ Developer-First CLI: One command to rule them all — nkapp up.
🌐 Automatic Networking: Built-in Caddy gateway with automated SSL (ACME) and local trust.
⚡ Resilient Telemetry: Real-time monitoring of your services across environments via the Nanokit Bridge.
🔐 Secure by Default: Native integration with Vault for secrets and automated SSH tunnel isolation.

Getting Started

To start your journey with Nanokit, we recommend following these steps:

Installation: Learn how to install the nkapp CLI on your machine.
First Project: Use nkapp init to scaffold your first zero-config application.
Local Dev: Run nkapp up -e local to see your services live with secure HTTPS.
Deploy: Move to VPS or Cloud with a single command.

Core Concepts

Nanokit is built on three main pillars:

The CLI (`nkapp`)

A powerful, deterministic tool that reconciles your desired state defined in nanokit.yml with the actual infrastructure.

The Bridge

A background process that connects your local machine to remote environments, providing telemetry, logs, and control without exposing your servers.

The Config (`nanokit.yml`)

A single, declarative YAML file that describes your entire application stack, from Docker images to cloud networks and database branches.