Skip to content

CLI Reference

The apkg command-line interface is how you interact with the APKG ecosystem — installing packages, publishing your own, managing credentials, and configuring your environment.

Pages that already have dedicated reference docs are linked below. Additional commands are listed for completeness and are the next priority for CLI documentation coverage.

Run apkg --help to see a summary of all commands, or apkg <command> --help for usage details on any specific command.

CommandDescription
initCreate a new apkg.json manifest interactively
loginAuthenticate with the registry
logoutRemove stored credentials
whoamiShow the currently authenticated user
CommandDescription
addAdd a package to your dependencies and install it
removeRemove a package from your dependencies
installDownload and install all dependencies
updateUpdate packages to their latest compatible versions
searchSearch the registry for packages
infoShow metadata for a published package
CommandDescription
packCreate a tarball from the current package
publishPack and upload a package to the registry
deprecateMark a package or version as deprecated
dist-tagManage distribution tags (add, remove, list)
CommandDescription
configManage CLI configuration — set, get, list, and delete values
CommandDescription
keyManage Ed25519 signing keys (generate, list, register, revoke, rotate)
tokenManage long-lived API tokens (create, list, revoke)
verifyVerify signatures and integrity of installed packages
CommandDescription
linkCreate symlinks for local package development
unlinkRemove development symlinks
CommandDescription
add-to-pathAdd apkg to your shell PATH
cacheManage the global package cache (clean, list, verify)
completionsGenerate shell completion scripts for bash, zsh, or fish