Kubectl API Reference

const output = await k.run('get pods -o wide');

const cmd = k.command('get pods');
// Returns: "kubectl get pods -n default"

// Get a specific resource
const pod = await k.get('pod', 'nginx');

// List resources
const pods = await k.get('pods');

// With options
const filtered = await k.get('pods', undefined, {
  selector: 'app=nginx',
  fieldSelector: 'status.phase=Running',
  allNamespaces: true,
  output: 'wide',
});

const phase = await k.getJsonPath('pod', 'nginx', '.status.phase');

const found = await k.exists('pod', 'nginx'); // boolean

const info = await k.clusterInfo();
// { reachable, controlPlane?, coreDNS?, serverVersion?, error? }

const result = await k.apply(`
apiVersion: v1
kind: Pod
metadata:
  name: nginx
spec:
  containers:
  - name: nginx
    image: nginx:alpine
`);

await k.delete('pod', 'nginx');
await k.delete('pod', 'nginx', { force: true });

// Default: wait for "Running", timeout 60s
await k.waitForPod('nginx');

// Custom status and timeout
await k.waitForPod('nginx', 'Succeeded', 120_000);

await k.wait('deployment', 'app', 'Available', { timeout: 120_000 });
await k.wait('pod', 'nginx', 'delete', { forDelete: true });

await k.waitForJsonPath('pod', 'nginx', '.status.phase', 'Running', 60_000);

await k.waitForReplicas('deployment', 'app', 3, 120_000);

await k.waitForService('my-svc', 30_000);

const logs = await k.logs('nginx');
const logs = await k.logs('nginx', {
  container: 'sidecar',
  tail: 100,
  since: '5m',
  previous: true,
});

const result = await k.exec('nginx', 'cat /etc/hostname');
const result = await k.exec('nginx', 'ls', { container: 'sidecar' });

const desc = await k.describe('pod', 'nginx');

await k.scale('deployment', 'app', 5);

await k.patch('deployment', 'app', { spec: { replicas: 3 } });
await k.patch('deployment', 'app', patch, 'merge'); // "strategic" | "merge" | "json"

await k.label('pod', 'nginx', { env: 'staging', team: 'backend' });

await k.annotate('pod', 'nginx', { 'description': 'test pod' });

await k.rollout.status('deployment', 'app');
await k.rollout.restart('deployment', 'app');
await k.rollout.pause('deployment', 'app');
await k.rollout.resume('deployment', 'app');
await k.rollout.undo('deployment', 'app');        // Latest revision
await k.rollout.undo('deployment', 'app', 2);     // Specific revision
await k.rollout.history('deployment', 'app');

const pf = await k.portForward('pod/nginx', '8080:80');
console.log('Local port:', pf.localPort);

// Stop forwarding when done
pf.stop();

const events = await k.getEvents();
const events = await k.getEvents({ fieldSelector: 'involvedObject.name=nginx' });

const nodes = await k.getNodes();
const nodes = await k.getNodes({ selector: 'node-role.kubernetes.io/worker' });

await k.cp('/local/file.txt', 'nginx:/tmp/file.txt');
await k.cp('nginx:/tmp/file.txt', '/local/file.txt');

k.setNamespace('kube-system');
await k.get('pods'); // Now queries kube-system

const ns = k.getNamespace(); // e.g. "default"

const kubeconfig = k.getKubeconfig(); // string | undefined

const exportCmd = k.setCluster('/path/to/kubeconfig');
// Returns: "export KUBECONFIG='/path/to/kubeconfig'"

const watch = await k.get('pods', undefined, { watch: true, output: 'wide' });
// ... observe changes ...
await watch.interrupt();