From 2a4bcb57e1c29c19092c555971afd84accb914b4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 18 Nov 2026 17:18:26 +0000 Subject: [PATCH] docs: show deprecated plugins in plugin list, search, and browse --- datumctl/plugins/using-plugins.mdx | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/datumctl/plugins/using-plugins.mdx b/datumctl/plugins/using-plugins.mdx index db35846..9bd1dfd 100644 --- a/datumctl/plugins/using-plugins.mdx +++ b/datumctl/plugins/using-plugins.mdx @@ -41,7 +41,7 @@ datumctl plugin search deploy --index acme Results show the plugin name, the catalog it came from, its version, its trust badge, and a short description. -For scripts and coding agents, pass `-o json` or `-o name`. `-o json` prints an array of objects with `name`, `index`, `version`, `trust`, and `description` fields, or `[]` when nothing matches. `-o name` prints one plugin name per line: +For scripts and coding agents, pass `-o json` or `-o name`. `-o json` prints an array of objects with `name`, `index`, `version`, `trust`, and `description` fields, or `[]` when nothing matches. A plugin its catalog marks deprecated also has a `deprecated` object with the catalog's `message` and `replacement`. `-o name` prints one plugin name per line: ```bash datumctl plugin search --index datum -o json @@ -119,12 +119,13 @@ datumctl plugin list This shows each installed plugin with its catalog, version, trust badge, description, and a status indicator: -| Status | Meaning | -|----------|-----------------------------------------------------| -| `ok` | Installed and compatible with this datumctl. | -| `update` | A newer version is available in its catalog. | -| `!` | Built for a different datumctl version. | -| `?` | Version information is unavailable. | +| Status | Meaning | +|--------------|-----------------------------------------------------| +| `ok` | Installed and compatible with this datumctl. | +| `update` | A newer version is available in its catalog. | +| `deprecated` | Its catalog marks the plugin deprecated. See [Deprecated plugins](#deprecated-plugins). | +| `!` | Built for a different datumctl version. | +| `?` | Version information is unavailable. | ## Running an installed plugin @@ -179,6 +180,12 @@ If other catalogs also have a plugin with that name, the collision error lists o `datumctl plugin install --all-available` skips a deprecated plugin you haven't installed and prints `Skipped : deprecated`. A deprecated plugin you already have is still upgraded, or reported as up to date, and datumctl prints its deprecation warning. +Listings flag deprecated plugins too: + +- `datumctl plugin list` shows `deprecated` in the `STATUS` column in place of `update`. When a newer version also exists, datumctl still suggests `datumctl plugin upgrade`. A plugin built for a different datumctl version still shows `!`, and one without version information still shows `?`. After the table, datumctl prints the deprecation warning for each deprecated plugin to stderr, whatever its status. `plugin list` reads only the catalog indexes datumctl has cached, so run `datumctl plugin search` to refresh them. +- `datumctl plugin search` adds `[deprecated]` before the description and prints the warning for each deprecated result to stderr after the table. With `-o json`, each deprecated result carries a `deprecated` object instead. `-o json` and `-o name` print no warnings. +- `datumctl plugin browse` adds `(deprecated)` after the plugin name and shows the warning in the plugin's details. + ## How plugins stay trustworthy datumctl treats a plugin as untrusted code and protects you in a few ways: