Skip to content

About

For publishing plugins for Codex so that they can be submitted to the marketplace.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

6 Commits

Folders and files

Hedera plugin marketplace for Codex

Hedera plugins for Codex, Codex Desktop and ChatGPT Desktop. The marketplace is named hedera. It is open: anyone can propose a plugin with a pull request (see CONTRIBUTING.md).

The available plugins are the entries in .agents/plugins/marketplace.json.

Install

codex plugin marketplace add hashgraph/hedera-codex-marketplace
codex plugin add <plugin>@hedera

To pick up new releases:

codex plugin marketplace upgrade hedera

Codex CLI, Codex Desktop and the ChatGPT Desktop Work tab share the same local configuration, so installing once makes the plugin available in all of them.

Two ways to list a plugin

Every plugin is one object in the plugins array of the manifest. It takes one of two forms.

1. In-repo. The plugin's files live in this repository, under plugins/<name>/, with a .codex-plugin/plugin.json (or a root plugin.json) that has the same name and a semver version:

{
  "name": "my-plugin",
  "description": "What it does.",
  "source": { "source": "local", "path": "./plugins/my-plugin" },
  "policy": { "installation": "AVAILABLE", "authentication": "ON_INSTALL" },
  "category": "Developer Tools"
}

Users only receive an update when version in the plugin's manifest changes, so every update PR bumps it. A plugin whose source lives in another repository can send its build output here with a pull request, by hand or from its own release workflow.

2. Pinned git. The entry points at a public repository and a commit. Nothing is copied here:

{
  "name": "my-plugin",
  "description": "What it does.",
  "source": {
    "source": "git-subdir",
    "url": "https://github.com/my-org/my-plugins.git",
    "path": "./plugins/my-plugin",
    "ref": "v1.2.0",
    "sha": "0123456789abcdef0123456789abcdef01234567"
  },
  "policy": { "installation": "AVAILABLE", "authentication": "ON_INSTALL" },
  "category": "Developer Tools"
}

url (plugin at the repository root) and git-subdir are accepted. sha is required and must be the full 40-character commit. Reviewers approve exactly that commit, and an update is a pull request that changes sha. Details are in the Codex plugin docs.

What CI checks

scripts/validate-marketplace.mjs runs on every pull request:

  • The marketplace is named hedera and has a display name.
  • Plugin names are valid and unique, and every entry has policy and category.
  • An in-repo entry points at ./plugins/<name>, that folder exists, and its manifest has the same name and a semver version.
  • A pinned git entry uses https:// and a full sha that can be fetched.
  • Every folder in plugins/ has an entry, and no folder holds key material, .env files or a keystore.

Run it locally with node scripts/validate-marketplace.mjs . --check-remote.

Review

Maintainers approve every change through CODEOWNERS. Sign off every commit for the DCO (git commit -s). Pull request titles must follow Conventional Commits.

About

For publishing plugins for Codex so that they can be submitted to the marketplace.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages