apkg publish

The publish command creates a tarball from the current directory, computes its SHA256 integrity hash, and uploads it to the registry. You must be logged in before publishing.

Synopsis

apkg publish [--registry <URL>]

Options

Option	Description
--registry <URL>	Override the registry URL for this publish

Requirements

Before publishing, make sure:

1. An apkg.json manifest exists in the current directory (see apkg init).
2. The package name is scoped — @username/name or @org/name.
3. You are authenticated — run apkg login first.

Scope validation

The command checks that the scope in your package name matches your logged-in username. If it doesn’t (e.g. you are publishing under an organization scope), a warning is shown. Publishing will still succeed if you are a member of that organization.

Published metadata

The following fields from apkg.json are sent to the registry:

Field	Required
name	Yes
version	Yes
type	Yes
integrity	Yes (computed automatically)
description	No
license	No
keywords	No
dependencies	No

Examples

Publish the package in the current directory:

apkg publish

Publish to a private registry:

apkg publish --registry https://registry.internal.example.com

Typical workflow — initialize, then publish:

apkg init
# ... add your package files ...
apkg publish

Related commands

Command	Description
init	Create an apkg.json manifest
login	Authenticate with the registry
pack	Create a tarball without uploading
deprecate	Mark a published package or version as deprecated
dist-tag	Manage distribution tags on published versions