Nais Command Line Interface

This repository contains the source code for the Nais command line interface (CLI).

See the CLI documentation for usage instructions.

Local Development

Adding a command that uses nais-relay

Follow the shared relay integration requirements and fill in the integration template in the product's design or rollout documentation. A new command needs a product-specific authenticated NAIS API mutation and an approved target policy; the CLI does not create RelayAccess resources.

Install the required go version:

mise install

Build Nais CLI

mise run build

Run tests

mise run test

Verify Nais CLI

./bin/nais --version

Setup shell completion for local builds

source <(./bin/nais completion zsh|bash|fish|powershell)

Instrumentation

We use otel for instrumentation and record the user interaction with the CLI to see if we can optimize the user experience.

We respect your privacy and do not collect any data if you set the environment variable DO_NOT_TRACK according to the Do Not Track.

There's a grafana dashboard.

Contributing

This repo uses Conventional Commits. Please read up on how to format your commit messages. Please see the pre-commit hook to see which types we allow.