Skip to main content
Northflank is a PaaS that allows you to run persistent sandboxes either on the Northflank infrastructure or your GCP/AWS. You can read more about it here.

Installation

First, install the Northflank provider package:

How to use

To use Northflank with VibeKit, you need to configure Northflank when creating a new VibeKit instance. Note that you must create a new project and API key in the Northflank dashboard.

Using the provider directly

Using configuration object

Configuration Options

  • apiKey (required): The API token you generated in the Northflank dashboard for authentication
  • image (optional): Override the inferred agent sandbox image with a custom image
  • projectId (optional): The project name you created in the Northflank dashboard
  • billingPlan (optional): Determines the CPU & RAM of the sandboxes (default: nf-compute-200 which has 2 vCPU & 4096GB RAM)
  • persistentVolumeStorage (optional): The persistent volume size in MB (default: 10240 for 10GiB)

ENV variables and secrets

You can use environment variables for your Northflank configuration:
Then reference them in your code: