K3 CLI Guide

Last validated: 2026-05-14

This CLI guide is split by command domain so each page can go deeper on flags, examples, and practical usage.

Validation sources:

• cli-shell/cli-k3/cmd/*.go
• cli-shell/cmd/k3.go
• dodil-k3/proto/proto-k3/*.proto (for API mapping notes)

Start Here

1. CLI Basics

• Invocation model, auth/config precedence, global flags.

2. Bucket and Object Commands

• Bucket lifecycle and object upload/inspect/remove patterns.

3. Source and Credential Commands

• Source creation, credential storage, OAuth workflow commands.

4. Pipeline, Template, and Ingest Commands

• Pipeline lifecycle and ingest orchestration commands.

5. Vector Commands

• Vector engine, collection management, and search CLI usage.

6. Table and Engine Commands

• Table SQL, mutation, maintenance, and engine controls.

7. Mount Commands

• Filesystem mount flows, daemon lifecycle, and unmount troubleshooting.

8. CLI Coverage Gaps and API Fallbacks

• What is not first-class in CLI and how to handle it safely.

Top-Level Command Groups

• bucket
• source
• credential (alias cred)
• object
• pipeline
• template
• ingest (alias rule)
• vector-store
• vector-collection
• search
• engine
• table
• mount
• unmount

For end-to-end command sequences, see 06-workflows.md.