Skip to content

Add the datumctl CLI documentation section#40

Merged
scotwells merged 1 commit into
mainfrom
docs/datumctl-cli-docs
Jul 2, 2026
Merged

Add the datumctl CLI documentation section#40
scotwells merged 1 commit into
mainfrom
docs/datumctl-cli-docs

Conversation

@scotwells

@scotwells scotwells commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What this adds

A complete, task-oriented datumctl (CLI) documentation section that takes a user from install to confidently operating Datum Cloud from the terminal — written around what people are trying to do, not a flag dump.

The guides

  • Getting started — overview and a hands-on quickstart from install to first command.
  • Authentication — browser login, service accounts for automation, and managing accounts, sessions, and tokens.
  • Core concepts — contexts & scoping (the Fix writing style and tone inconsistencies #1 source of "why did I get nothing back?"), discovering resources & schemas, and output formats & scripting.
  • Working with resources — reading, changing, and safely previewing changes before they land.
  • Activity & audit — a persona-driven walkthrough of who changed what, events, and the change feed.
  • Interactive console — the full-screen terminal UI.
  • AI & MCP — the natural-language assistant and connecting AI clients over MCP.
  • CI/CD — installing and authenticating datumctl in GitHub Actions and other pipelines.
  • Plugins — using plugins, adding catalogs, and publishing catalogs and plugins.
  • Kubernetes interop — for existing kubectl users: kubectl, Helm/k9s, and GitOps with Flux & Argo CD.

Cleanup

  • Retires the auto-generated CLI Commands reference tab; command and flag help now points users at the always-current datumctl --help.

Draft for preview review. The separate API resource reference is tracked on the docs/api-reference-wip branch and will land as its own PR.

@scotwells
docs: add a task-oriented datumctl CLI section
71a6955 
Introduces a full datumctl guide set: getting started and quickstart,
authentication and service accounts, contexts and scoping, discovering
resources and schemas, reading and changing resources safely, the
activity and audit trail, the interactive console, AI and MCP, CI/CD,
plugins and marketplaces, and Kubernetes interop (kubectl, Helm/k9s,
GitOps). Retires the auto-generated CLI Commands reference tab in favor
of built-in 'datumctl --help'.
@scotwells scotwells mentioned this pull request Jul 2, 2026
Closed
@scotwells scotwells marked this pull request as ready for review July 2, 2026 15:31
@scotwells scotwells marked this pull request as draft July 2, 2026 15:36
@scotwells scotwells marked this pull request as ready for review July 2, 2026 15:42
@mintlify

mintlify Bot commented Jul 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Datum 🟢 Ready View Preview Jul 2, 2026, 3:56 PM

@scotwells scotwells merged commit 4410910 into main Jul 2, 2026
4 checks passed
@scotwells scotwells deleted the docs/datumctl-cli-docs branch July 2, 2026 17:03
@scotwells scotwells mentioned this pull request Jul 2, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kaleygel kaleygel kaleygel approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@scotwells @kaleygel