Install the agent
The recommended way to install the nullplatform agent is via Helm. This method gives you full control over authentication, tags, and GitHub integration—and fits well into CI/CD workflows.
If you're just trying things out, you can also run our quick-install script.
Installation methods
- Recommended: Install via Helm (best for production and automation)
- Use the CLI script to install in one step
- Run the agent locally for testing (e.g., in Minikube)
Helm installation
Prerequisites
Before you begin, make sure you have:
- A Kubernetes cluster
- Helm 3+
1. Create an API key
From the nullplatform UI:
- Go to Platform settings > API keys, and click + New API key.
- Select the account resource where the API key's roles will be assigned.
⚠️ Important: Roles must be assigned at the account level or the setup won’t work.
- Select the roles:
ops, andsecops. - Save your API key somewhere safe—you'll need it shortly.
2. Add the Helm repository
helm repo add nullplatform https://nullplatform.github.io/helm-charts
helm repo update
3. Set environment variables
These environment variables configure the agent’s API key, tags, and scope source.
export NP_API_KEY=<your_api_key>
export AGENT_TAGS=<"key:value">
export GITHUB_REPO=your-org/your-repo
export GITHUB_TOKEN=your_github_token
You can customize the tags using this format:
export AGENT_TAGS="env:dev,team:secops"
4. Install the chart
Use the following command to install the agent with your configuration:
helm install nullplatform-agent nullplatform/nullplatform-agent \
--set configuration.values.NP_API_KEY=$NP_API_KEY \
--set configuration.values.TAGS="$AGENT_TAGS" \
--set configuration.values.GITHUB_REPO=$GITHUB_REPO
--set configuration.values.GITHUB_REPO=$GITHUB_TOKEN
- See all config options in the Helm charts docs.
- View the source in the agent Helm chart repo.
Quick install
If you just want to install the agent using a script, use our one-line installer:
curl https://cli.nullplatform.com/agent/install.sh | bash
Verify installation
Let’s make sure everything is working properly.
Check the agent in the UI
- Grab the agent ID from the install logs. It looks like this:
"id\":\"123b245d-6e7b-4c56-d78e-12f34b50\" - In the platform UI, go to Platform settings > Agents.
- You should see your new agent listed by that ID.
Want to test locally?
If you're setting up the agent in a local environment (like Minikube), follow our step-by-step guide: