Before you begin#
You need a shared IAM organization in which you are an owner/admin, a unique application handle, a real HTTPS webhook receiver and its signing secret, and native CLI builds for all six required targets. Honeycomb packages binaries; it does not compile your application.
1. Prepare the package#
Create a directory with a root honeycomb.yaml and the six platform payloads under targets/. Every target must map every declared command to a nonempty executable. Use the manifest reference and downloadable manifest.
honeycomb validate ./my-app
honeycomb pack ./my-app --output my-app-1.0.0.tar.gz
honeycomb validate ./my-app-1.0.0.tar.gz
When the manifest is missing, pack creates a starter template and asks you to populate it. It does not manufacture missing native builds. Use the version in your manifest to name the archive.
2. Register in the console#
- Open the console and sign in.
- Choose Create application and the owning organization.
- Set the permanent handle, display name, and 50–1,000 word description.
- Under First CLI release, choose your
.tar.gz. - Configure your HTTPS webhook URL, signing secret, and needed scopes.
- Submit Create private application and securely save any one-time application secret.
The console validates the archive before registration, including its application ID. After registration it opens Releases and uploads the selected archive. If upload fails after registration, retry the upload for that existing application; do not create a second app. Text fields can be saved as a shared draft, but files and signing secrets must be supplied again after reopening it.
You may leave the first release empty to create configuration first. A valid six-target release is required before publication.
3. Or register and upload through the CLI#
Prepare a private application.json using the application configuration reference. Then:
honeycomb --idempotency-key my-app-create-0001 apps create application.json
honeycomb apps get 'my-org>my-app' --json
Wait for IAM acceptance if creation returns a pending operation. Read the returned application revision; use that current number below instead of assuming it is always 1.
honeycomb --idempotency-key my-app-upload-0001 releases upload 'my-org>my-app' my-app-1.0.0.tar.gz --revision 1
honeycomb releases list 'my-org>my-app'
Reuse the same idempotency key, revision, and archive if the response was lost. A new semantic version is required for different release bytes.
4. Verify private installation#
While signed in with access to the owning organization:
honeycomb install 'my-org>my-app' --version 1.0.0
honeycomb installed
Run your installed command's help and a representative operation. Test native builds on their actual operating systems; archive shape validation alone does not prove a binary runs.
5. Request public distribution#
Follow Publication and reviews. Private registration, successful storage, and public approval are separate states. If your archive or logo upload reports missing delegated permissions, use Troubleshooting; the platform's Briefcase integration must be configured first.