Quick Reference

This page is meant to be copy-paste friendly. It is not the full CLI specification; it is the shortest practical command list for day-to-day use.

General

Check the CLI version:

pk3s version

Show the recursive bill of materials for the CLI and the bundles it resolves:

pk3s bom --json | jq

Use local sibling repositories instead of published remote bundles:

PRODUCTIVE_K3S_SOURCE=local pk3s bom --json | jq

Catalog and discovery

List published profiles from the catalog:

pk3s profile list

Show one profile and its install inputs summary:

pk3s profile show multipass-1-server-2-agents

List published addons from the catalog:

pk3s addon list

Profiles and infrastructure

Validate a published profile package:

pk3s profile validate multipass-1-server-2-agents

Install a local Multipass cluster from a published profile:

pk3s infra install multipass-1-server-2-agents

Check the current status of that profile deployment:

pk3s infra status multipass-1-server-2-agents

Destroy that profile deployment:

pk3s infra destroy multipass-1-server-2-agents

Install a profile that requires installation-specific local overrides:

pk3s infra install aws-single-node-basic --env-file ./aws.env

Inspect a profile before installing so you know whether --env-file is required:

pk3s profile show aws-single-node-basic

Addons

Validate a published addon package:

pk3s addon validate nginx

Install an addon into a previously installed profile target:

pk3s addon install nginx --profile multipass-1-server-2-agents

Install an addon and expose it publicly through Traefik with a single ingress host:

pk3s addon install nginx --profile multipass-1-server-2-agents --public-host nginx.k3s.lab.internal

Install an addon against an explicit kubeconfig instead of a profile:

pk3s addon install nginx --kubeconfig ~/.kube/config

Install an addon against a specific kube context:

pk3s addon install nginx --cluster-context default

Telemetry

Show the current telemetry preference:

pk3s config telemetry status

Enable persisted telemetry preference:

pk3s config telemetry enable

Disable telemetry for a single mutating command:

pk3s infra install multipass-1-server-2-agents --telemetry disable

Short Notes

• profile list, profile show, addon list, bom --json, and version are read-only commands.
• infra install, infra destroy, and addon install are mutating commands.
• addon install --profile <name> requires profile state from a previous infra install or infra status.
• --public-host only works when the addon package declares support for the basic Core-managed ingress contract.