buildify-publish-cli 1.0.3

CLI for Buildify bundle publish server (machine Bearer auth)

buildify-publish-cli

Command-line client for the Buildify bundle publish HTTP API. Use it to check health, validate publish keys, query bundle metadata, and upload JAR bundles from your terminal or CI.

Requires: Python 3.10 or newer.

Install

From PyPI:

pip install buildify-publish-cli

Other installers:

pipx install buildify-publish-cli
uv tool install buildify-publish-cli

After install, the command is buildify-publish.

Authentication

The API uses Bearer credentials: Authorization: Bearer <keyId>.<secret>.

Set the full secret (both parts after Bearer) as:

• Environment variable BUILDIFY_PUBLISH_API_KEY, or
• buildify-publish config set-api-key (reads from stdin — avoids putting the secret on the command line).

Publish keys are created and rotated in the Buildify console, not through this CLI.

Quick start

export BUILDIFY_PUBLISH_API_KEY='yourKeyId.yourSecret'

buildify-publish health
buildify-publish key test
buildify-publish bundle info --name 'my/group/plugin'
buildify-publish bundle upload \
  --name 'my/group/plugin' \
  --version '1.0.0-SNAPSHOT' \
  --file ./plugin.jar \
  --overwrite \
  --release-notes-file ./CHANGELOG.md

发布说明： bundle upload 支持 --release-notes-file（UTF-8 Markdown，通常为本仓库根目录 CHANGELOG.md），随 JAR 以 multipart 字段 releaseNote 提交至 POST /v1/bundles/versions；服务端写入 bundle_version_release_note（与控制台开发者上传、§十八 一致）。规范要求见 docs/spec/dev-spec.md §17.7。

API base URL

Default: https://publish.buildify.cn

Override for self-hosted or other environments:

export BUILDIFY_PUBLISH_BASE_URL='https://your-publish-host.example.com'
# or per invocation:
buildify-publish --base-url 'https://your-publish-host.example.com' health

Persist in ~/.buildifyrc — two separate settings (set either or both; order does not matter):

• base_url — which publish API host to call (default host above if unset).
• api_key — your publish credential keyId.secret, unrelated to the URL.

# Set only the API host (skip if the default https://publish.buildify.cn is fine)
buildify-publish config base_url https://publish.buildify.cn

# Set only the key (stdin avoids putting the secret in shell history)
printf '%s' 'keyId.secret' | buildify-publish config set-key api_key

buildify-publish config show

Use config set-key / config set_key with base_url or api_key. For api_key, omit the value or use - to read from stdin.

Shortcuts config set-base-url and config set-api-key update the same two fields.

File: ~/.buildifyrc (Unix) or %USERPROFILE%\.buildifyrc (Windows). Precedence: CLI flags → BUILDIFY_PUBLISH_BASE_URL / BUILDIFY_PUBLISH_API_KEY → file → default base URL.

Built-in reference

Full Markdown reference (commands, env vars, HTTP mapping, exit codes, JSON schema):

buildify-publish help

Same content ships as usage.md inside the package.

Scripting and CI

Machine-readable output (one JSON object per run):

export BUILDIFY_PUBLISH_JSON=1
buildify-publish --json key test

Environment: BUILDIFY_PUBLISH_BASE_URL, BUILDIFY_PUBLISH_API_KEY, BUILDIFY_PUBLISH_JSON, NO_COLOR.

Global flags: --json, --api-key, --base-url, --quiet.

Developing from source

If you have the Git repository checked out:

cd tools/buildify-publish-cli
python3 -m venv .venv && source .venv/bin/activate
pip install -U pip
pip install .

Run without installing into the environment:

python -m buildify_publish --help

License

Same as the upstream project repository unless stated otherwise.