An open API service indexing awesome lists of open source software.

https://github.com/nais/cli

A Nais CLI
https://github.com/nais/cli

cli kafka kubernetes nais postgres

Last synced: 3 months ago
JSON representation

A Nais CLI

Awesome Lists containing this project

README

          

# Nais Command Line Interface

This repository contains the source code for the [Nais](https://nais.io) command line interface (CLI).

See the [CLI documentation](https://cli.nais.io) for usage instructions.

## Local Development

### Install the required go version:

```bash
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](https://opentelemetry.io) 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](https://consoledonottrack.com).

There's a [grafana dashboard](https://monitoring.nais.io/d/ce2c9sehbbbwgd/nais-cli?orgId=1&from=now-24h&to=now).

## Contributing

This repo uses [Conventional Commits](https://www.conventionalcommits.org/). Please read up on how to format your commit messages. Please see the [pre-commit hook](script/semantic-commit-hook.sh) to see which types we allow.