Skip to content

apkg install

The install command downloads and extracts packages into apkg_packages/. When run without arguments it installs every dependency listed in apkg.json. When given a package name it installs that single package.

Packages are cached locally so repeated installs are fast. Every download is verified against its SHA256 integrity hash.

Terminal window
apkg install [<package>] [--setup <tool>] [--no-setup] [--frozen-lockfile]
OptionDescription
--setup <tool>Generate configuration for a specific tool (e.g. claude-code)
--no-setupSkip post-install tool setup entirely
--frozen-lockfileFail if the lockfile is missing or would change (useful for CI)
Terminal window
apkg install

Reads apkg.json, resolves all dependencies, downloads and extracts each package, and writes or updates apkg-lock.json. Tool setup runs for every installed package that supports it.

Terminal window
apkg install <package>

Works like apkg add for downloading and extracting, but does not add the package to apkg.json dependencies. The lockfile is still updated. The <package> argument supports the same formats as add@scope/name, @scope/name@version, or @scope/name@tag.

The --frozen-lockfile flag is designed for CI environments where you want reproducible installs. It ensures that:

  1. An apkg-lock.json file already exists — the command fails if it is missing.
  2. The resolved dependency tree exactly matches the lockfile — the command fails if any package would be added, removed, or changed.
Terminal window
apkg install --frozen-lockfile

After installation, apkg can generate configuration files for AI coding tools. When installing all dependencies, setup runs for every eligible package (types skill and agent). Use --setup claude-code to target a specific tool, or --no-setup to skip setup entirely. See Tool Setup Explained for how detection, precedence, and file generation work.

Install all dependencies from apkg.json:

Terminal window
apkg install

Install all dependencies in CI with a locked dependency tree:

Terminal window
apkg install --frozen-lockfile

Install a single package by name:

Terminal window
apkg install @acme/code-reviewer

Install all dependencies and set up Claude Code:

Terminal window
apkg install --setup claude-code
CommandDescription
addAdd a package to dependencies and install it
removeRemove a package from your dependencies
updateUpdate packages to latest compatible versions
configSet defaultSetup to control automatic tool setup