1 Commits

• [codex] add plugin marketplace CLI commands (#21396)

  ## Why
  
  Plugin CLI installs should behave more like `apt-get install`:
  configured marketplaces are the only install sources, the local
  marketplace snapshot is the package index used at install time, and
  `plugins/cache` is only a cache of already-downloaded plugin bytes.
  
  That distinction matters once marketplaces and plugins have auth or
  availability state. A repo-local marketplace manifest or leftover cached
  plugin artifact should not silently become an install source unless the
  marketplace was explicitly configured and its readable snapshot still
  authorizes the plugin.
  
  ## What Changed
  
  - add CLI commands to list configured marketplaces and add, list, or
  remove marketplace plugins
  - accept stable `plugin@marketplace` ids for add/remove while preserving
  the explicit `--marketplace` form
  - restrict `codex plugin add` and `codex plugin list` to configured
  marketplaces instead of also discovering current-working-directory
  marketplace roots
  - fail `codex plugin add` and `codex plugin list` when a configured
  marketplace snapshot is missing or malformed instead of treating it as
  an empty source or a generic plugin miss
  - preserve marketplace snapshot semantics: a configured local/Git
  marketplace snapshot can authorize installs without consulting the
  original upstream source
  - allow `plugins/cache` reuse only after configured marketplace
  resolution succeeds
  - keep removal resilient after marketplace deletion or drift and ignore
  malformed marketplace config entries in listing
  
  ## Commands Added
  
  - `codex plugin add <plugin>@<marketplace>`
  - `codex plugin add <plugin> --marketplace <marketplace>`
  - `codex plugin list`
  - `codex plugin list --marketplace <marketplace>`
  - `codex plugin remove <plugin>@<marketplace>`
  - `codex plugin remove <plugin> --marketplace <marketplace>`
  - `codex plugin marketplace add <source>`
  - `codex plugin marketplace add <source> --ref <ref>`
  - `codex plugin marketplace add <source> --sparse <path>`
  - `codex plugin marketplace list`
  - `codex plugin marketplace upgrade`
  - `codex plugin marketplace upgrade <marketplace>`
  - `codex plugin marketplace remove <marketplace>`
  
  ## CLI Help Output
  
  <details>
  <summary><code>codex plugin --help</code></summary>
  
  ```text
  Manage Codex plugins
  
  Usage: codex plugin [OPTIONS] <COMMAND>
  
  Commands:
    add          Install a plugin from a configured marketplace snapshot
    list         List plugins available from configured marketplace snapshots
    marketplace  Add, list, upgrade, or remove configured plugin marketplaces
    remove       Remove an installed plugin from local config and cache
    help         Print this message or the help of the given subcommand(s)
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin add --help</code></summary>
  
  ```text
  Install a plugin from a configured marketplace snapshot.
  
  Pass either `PLUGIN@MARKETPLACE` or pass `PLUGIN` with `--marketplace MARKETPLACE`.
  
  Usage: codex plugin add [OPTIONS] <PLUGIN[@MARKETPLACE]>
  
  Arguments:
    <PLUGIN[@MARKETPLACE]>
            Plugin selector to install: either PLUGIN@MARKETPLACE or PLUGIN with --marketplace
  
  Options:
    -m, --marketplace <MARKETPLACE>
            Configured marketplace name to use when PLUGIN does not include @MARKETPLACE
  
  Examples:
    codex plugin add sample@debug
    codex plugin add sample --marketplace debug
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin list --help</code></summary>
  
  ```text
  List plugins available from configured marketplace snapshots
  
  Usage: codex plugin list [OPTIONS]
  
  Options:
    -m, --marketplace <MARKETPLACE>
            Only list plugins from this configured marketplace name
  
  Examples:
    codex plugin list
    codex plugin list --marketplace debug
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin remove --help</code></summary>
  
  ```text
  Remove an installed plugin from local config and cache.
  
  Pass either `PLUGIN@MARKETPLACE` or pass `PLUGIN` with `--marketplace MARKETPLACE`.
  
  Usage: codex plugin remove [OPTIONS] <PLUGIN[@MARKETPLACE]>
  
  Arguments:
    <PLUGIN[@MARKETPLACE]>
            Plugin selector to remove: either PLUGIN@MARKETPLACE or PLUGIN with --marketplace
  
  Options:
    -m, --marketplace <MARKETPLACE>
            Marketplace name to use when PLUGIN does not include @MARKETPLACE
  
  Examples:
    codex plugin remove sample@debug
    codex plugin remove sample --marketplace debug
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin marketplace --help</code></summary>
  
  ```text
  Add, list, upgrade, or remove configured plugin marketplaces
  
  Usage: codex plugin marketplace [OPTIONS] <COMMAND>
  
  Commands:
    add      Add a local or Git marketplace to the configured marketplace sources
    list     List configured marketplace names and their local snapshot roots
    upgrade  Refresh configured Git marketplace snapshots
    remove   Remove a configured marketplace source by name
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin marketplace add --help</code></summary>
  
  ```text
  Add a local or Git marketplace to the configured marketplace sources
  
  Usage: codex plugin marketplace add [OPTIONS] <SOURCE>
  
  Arguments:
    <SOURCE>
            Marketplace source: a local path, owner/repo[@ref], HTTPS Git URL, or SSH Git URL
  
  Options:
        --ref <REF>
            Git ref to fetch for Git marketplace sources
  
        --sparse <PATH>
            Sparse checkout path for Git marketplace sources. Can be repeated
  
  Examples:
    codex plugin marketplace add ./path/to/marketplace
    codex plugin marketplace add owner/repo --ref main
    codex plugin marketplace add https://github.com/owner/repo --sparse plugins/foo
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin marketplace list --help</code></summary>
  
  ```text
  List configured marketplace names and their local snapshot roots
  
  Usage: codex plugin marketplace list [OPTIONS]
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin marketplace upgrade --help</code></summary>
  
  ```text
  Refresh configured Git marketplace snapshots.
  
  Omit MARKETPLACE_NAME to upgrade all configured Git marketplaces.
  
  Usage: codex plugin marketplace upgrade [OPTIONS] [MARKETPLACE_NAME]
  
  Arguments:
    [MARKETPLACE_NAME]
            Optional configured marketplace name to upgrade. Omit to upgrade all Git marketplaces
  
  Examples:
    codex plugin marketplace upgrade
    codex plugin marketplace upgrade debug
  ```
  
  </details>
  
  <details>
  <summary><code>codex plugin marketplace remove --help</code></summary>
  
  ```text
  Remove a configured marketplace source by name
  
  Usage: codex plugin marketplace remove [OPTIONS] <MARKETPLACE_NAME>
  
  Arguments:
    <MARKETPLACE_NAME>
            Configured marketplace name to remove
  
  Example:
    codex plugin marketplace remove debug
  ```
  
  </details>
  
  ## Public Semantics
  
  - `codex plugin add <plugin>@<marketplace>` succeeds only when
  `<marketplace>` is configured and its local marketplace snapshot
  contains `<plugin>`
  - repo-local marketplaces are not install sources until the user runs
  `codex plugin marketplace add ...`
  - configured marketplace snapshots must be readable; missing or
  malformed snapshots fail the CLI operation rather than silently falling
  through to cache or empty results
  - cached plugin artifacts can satisfy reinstall only when the configured
  marketplace snapshot still authorizes that plugin
  - cached plugin artifacts alone never make a plugin installable
  
  ## Tests
  
  - `cargo test -p codex-cli --test plugin_cli`
  - `cargo clippy -p codex-cli --tests -- -D warnings`
  - `cargo test -p codex-cli`
  - `git diff --check`
  - `just bazel-lock-update`
  - `just bazel-lock-check`

  Casey Chow · 2026-05-14 09:33:38 -07:00
  74a1b46a00