oz0 hub submit
For: Operators and developers looking up a command.
Inspect a plugin at a pinned source as plugin inspect does (a Git URL at --ref, pinned to its commit, the packed content's SHA-256 and the forge's repository ID; a bundle file at --url; an oci:// reference by digest) and write its listing for a hub: the plugin's name is <publisher>/<manifest name>, where the publisher is a reverse-DNS namespace you can prove, such as io.github.<account> or com.example.
With --hub, the listing goes into that checkout of the hub repository, as a new listings/<publisher>/<plugin>.yaml or as a new version of the one there, and the pull request's text is printed (or written to --pr-text). With --hub and --sign-key, a signed copy of the submission goes next to it, as submissions/<publisher>/<plugin>/<version>.json: the hub's proof that the namespace's key, not just whoever opened the pull request, lists the version. Without --hub, the listing file is printed.
With --bundle and --sign-key, it writes a submission bundle instead, signed with your key (an engine key file from index keygen, or an unencrypted OpenSSH ed25519 key, the one you sign release tags with), for hubs that take submissions without GitHub: send the file to the hub's maintainers, who import it with the hub's own script. The hub's CI inspects the source again with its own pinned engine, so nothing here is taken on trust.
With --hub and --check, the checkout's own checks run on the listing just written, as the hub's pull request CI runs them (hubtool check against the commit the pull request goes into, --base or the merge base of HEAD with origin's default branch, with the engine its engine.lock pins), and show the same findings; it fails when they block the listing. It refuses a plugin past the README's limits or without a licence file (the docs page Plugin limits).
Usage
oz0 hub submit <git-url | bundle.tar.gz | oci://registry/repository@sha256:digest> --publisher <namespace> [flags]
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--allow-local | bool | let a remote source reach every address, this machine's included, and plain http:// and file://, for a repository or registry you serve yourself; without it a remote source reaches public addresses over https:// only, and the networks --allow-net lists | |
--allow-net | strings | a private network, such as 10.20.0.0/16, a remote source may reach over https://; this machine's own addresses (inside a listed network too), its link and metadata services need --allow-local; repeatable | |
--base | string | the merge base of HEAD with the checkout's origin/HEAD or origin/main, else HEAD | with --check: the commit the pull request goes into, which the checks diff against |
--bundle | string | write a signed submission bundle to this file, for a hub that takes submissions without GitHub | |
--check | bool | with --hub: run the checkout's own checks (its hubtool, built if needed) on the listing, as the hub's pull request CI does | |
--engine-source | string | with --check: an engine checkout to build the engine the hub's engine.lock pins from, when the hub's cache has none | |
--forge | string | from the host | the forge that hosts the repository: github, gitlab, gitea or none |
--homepage | string | the plugin's homepage, an https:// address | |
--hub | string | a checkout of the hub repository: write listings/<publisher>/<plugin>.yaml there | |
--issues | string | where to report bugs, an https:// address | |
--maintainer | stringArray | a maintainer, as "Name <email>" or a name; repeatable | |
--new-version | bool | for a --bundle: the plugin is listed already, so this is a new version, not a first listing | |
--path | string | the plugin's folder in the repository | |
--pr-author | string | $HUB_PR_AUTHOR | with --check: the forge account that will open the pull request, for the check of who changed the listing |
--pr-text | string | write the pull request's text to this file (title on the first line) instead of printing it | |
--publisher | string | your reverse-DNS namespace, such as io.github.<account> or com.example: the plugin is listed as <publisher>/<manifest name> | |
--ref | string | branch, tag or full commit SHA (default: the latest release tag, else the default branch); the listing pins the commit | |
--repository-id | string | the forge's ID of the repository, instead of asking the forge | |
--security | string | where to report a security problem, besides the hub's own report link: an https:// or mailto: address | |
--sign-key | string | the key to sign the submission with: an engine key file (index keygen) or an unencrypted OpenSSH ed25519 key; with --hub, a signed copy goes into the checkout's submissions/ | |
--summary | string | the manifest's description, which must then fit | one or two sentences about the plugin, at most 500 characters |
--tag | stringArray | a tag for the hub's search, such as support or github: 1 to 32 lowercase letters, digits and dashes; repeatable, up to the hub's tags.yaml max_per_listing with --hub | |
--track | string | tags: the hub's bot lists every release tag your signing identity signs (none by default) | |
--url | string | for a bundle file: the https:// URL it is published at |
Inherited flags
| Flag | Type | Default | Description |
|---|---|---|---|
--context | string | $OZ0_CONTEXT or <config dir>/orchestrator-zero/context.json | CLI context file written by server init |
--log-level | string | info | log level: debug, info, warn or error |
See all oz0 commands and the global flags.