# vlt docs

> Documentation for vlt, the package registry built for JavaScript: the vlt.io registry (private packages, npm mirrors, access control, tokens) and the `vlt` client, an npm-compatible package manager.

Every page is available as Markdown: append `.md` to its URL, or request the page with an `Accept: text/markdown` header. The links below point at the Markdown versions. [llms-full.txt](https://docs.vlt.io/llms-full.txt) holds every page except the generated API reference, plus the vlt-registry-migration skill, in one file.

## Using these docs

- New to the registry: start at [Quick Start](https://docs.vlt.io/registry.md). New to the client: start at [Getting Started with the vlt CLI](https://docs.vlt.io/client.md). Moving an existing repository onto a vlt.io registry: follow the [vlt-registry-migration skill](https://docs.vlt.io/skills/vlt-registry-migration/SKILL.md).
- Commands and config: [CLI Commands](https://docs.vlt.io/client/commands.md) links every command's page; [Configuring the vlt CLI](https://docs.vlt.io/client/configuring.md) covers options and config files. [Reference](https://docs.vlt.io/reference.md) is a glossary of terms.
- The site's own HTTP API (search, Markdown pages) is described at [openapi.json](https://docs.vlt.io/openapi.json).
- Before running anything that changes a vlt.io account (publishing, unpublishing, deprecating packages, changing access, or creating and revoking tokens), confirm with the user first.

## Agent skills

Follow a skill by reading its link. Skills with an `Install:` command can also be added to a project with the [skills CLI](https://skills.sh/docs/cli).

- [vlt-registry-migration](https://docs.vlt.io/skills/vlt-registry-migration/SKILL.md): Moves a JavaScript repository (single package or monorepo) onto a vlt.io registry. Routes installs through the account's npm mirror and private `main` registry, handles the lockfile, and sets up auth for npm, pnpm, yarn, bun, deno and the vlt CLI on laptops, CI, Vercel and coding-agent sandboxes. Use when the user wants to switch a repo or pipeline to registry.vlt.io, set up vlt.io tokens, or fix 401s or missing auth after switching. Install: `vlx skills add vltpkg/vltpkg -- --skill vlt-registry-migration`
- [dss-query](https://github.com/vltpkg/vltpkg/tree/main/src/query/skills/dss-query): Composes and explains vlt query selectors, including Socket-powered security audits. Install: `vlx skills add vltpkg/vltpkg -- --skill dss-query`

## Pages

- [Why vlt?](https://docs.vlt.io/why-vlt.md)
- [Use cases](https://docs.vlt.io/use-cases.md)
- [npm interoperability](https://docs.vlt.io/npm-interoperability.md)
- [Reference](https://docs.vlt.io/reference.md)
- Concepts
  - [Concepts](https://docs.vlt.io/concepts.md)
  - [Package Registry](https://docs.vlt.io/concepts/package-registry.md)
  - [Named Registries](https://docs.vlt.io/concepts/named-registries.md)
  - [Dependencies](https://docs.vlt.io/concepts/dependencies.md)
  - [Manifest](https://docs.vlt.io/concepts/manifest.md)
  - [Packuments](https://docs.vlt.io/concepts/packuments.md)

- **Registry**
- [Quick Start](https://docs.vlt.io/registry.md)
- [Using Packages](https://docs.vlt.io/registry/using-packages.md)
- [Members & Access Control](https://docs.vlt.io/registry/access.md)
- [Dashboard](https://docs.vlt.io/registry/dashboard.md)
- [Authentication & Tokens](https://docs.vlt.io/registry/tokens.md)
- Publishing
  - [Publishing Packages](https://docs.vlt.io/registry/publishing.md)
  - [vlt](https://docs.vlt.io/registry/publishing/vlt.md): Configure the vlt client for your vlt.io registries, and publish to main.
  - [npm](https://docs.vlt.io/registry/publishing/npm.md): Configure npm for your vlt.io registries, and publish to main.
  - [pnpm](https://docs.vlt.io/registry/publishing/pnpm.md): Configure pnpm for your vlt.io registries, and publish to main.
  - [yarn](https://docs.vlt.io/registry/publishing/yarn.md): Configure Yarn for your vlt.io registries, and publish to main.
  - [bun](https://docs.vlt.io/registry/publishing/bun.md): Configure bun for your vlt.io registries, and publish to main.
  - [deno](https://docs.vlt.io/registry/publishing/deno.md): Configure Deno for your vlt.io registries, and publish to main.
  - [CI & automation](https://docs.vlt.io/registry/publishing/ci.md): Install and publish from CI, Vercel and coding-agent sandboxes with a vlt.io service token.

- **Client**
- [Getting Started with the vlt CLI](https://docs.vlt.io/client.md)
- [Configuring the vlt CLI](https://docs.vlt.io/client/configuring.md)
- [Authentication](https://docs.vlt.io/client/auth.md)
- [Working with Named Registries](https://docs.vlt.io/client/registries.md)
- [Security & Malware Detection](https://docs.vlt.io/client/security.md)
- [Using Workspaces in a Monorepo Project with vlt](https://docs.vlt.io/client/workspaces.md)
- [Affected Dependencies](https://docs.vlt.io/client/affected.md)
- [Using Catalogs for Dependency Management](https://docs.vlt.io/client/catalogs.md)
- [Peer Dependencies Support](https://docs.vlt.io/client/peer-dependencies.md)
- [Graph Modifiers](https://docs.vlt.io/client/graph-modifiers.md)
- Commands
  - [CLI Commands](https://docs.vlt.io/client/commands.md)
  - [vlt bugs](https://docs.vlt.io/client/commands/bugs.md)
  - [vlt build](https://docs.vlt.io/client/commands/build.md)
  - [vlt cache](https://docs.vlt.io/client/commands/cache.md)
  - [vlt ci](https://docs.vlt.io/client/commands/ci.md)
  - [vlt config](https://docs.vlt.io/client/commands/config.md)
  - [vlt create](https://docs.vlt.io/client/commands/create.md)
  - [vlt docs](https://docs.vlt.io/client/commands/docs.md)
  - [vlt exec-cache](https://docs.vlt.io/client/commands/exec-cache.md)
  - [vlt exec-local](https://docs.vlt.io/client/commands/exec-local.md)
  - [vlt exec](https://docs.vlt.io/client/commands/exec.md)
  - [vlt help](https://docs.vlt.io/client/commands/help.md)
  - [vlt init](https://docs.vlt.io/client/commands/init.md)
  - [vlt install](https://docs.vlt.io/client/commands/install.md)
  - [vlt list](https://docs.vlt.io/client/commands/list.md)
  - [vlt login](https://docs.vlt.io/client/commands/login.md)
  - [vlt logout](https://docs.vlt.io/client/commands/logout.md)
  - [vlt outdated](https://docs.vlt.io/client/commands/outdated.md)
  - [vlt pack](https://docs.vlt.io/client/commands/pack.md)
  - [vlt ping](https://docs.vlt.io/client/commands/ping.md)
  - [vlt pkg](https://docs.vlt.io/client/commands/pkg.md)
  - [vlt publish](https://docs.vlt.io/client/commands/publish.md)
  - [vlt query](https://docs.vlt.io/client/commands/query.md)
  - [vlt registry](https://docs.vlt.io/client/commands/registry.md)
  - [vlt repo](https://docs.vlt.io/client/commands/repo.md)
  - [vlt run-exec](https://docs.vlt.io/client/commands/run-exec.md)
  - [vlt run](https://docs.vlt.io/client/commands/run.md)
  - [vlt setup](https://docs.vlt.io/client/commands/setup.md)
  - [vlt skills](https://docs.vlt.io/client/commands/skills.md)
  - [vlt token](https://docs.vlt.io/client/commands/token.md)
  - [vlt uninstall](https://docs.vlt.io/client/commands/uninstall.md)
  - [vlt version](https://docs.vlt.io/client/commands/version.md)
  - [vlt view](https://docs.vlt.io/client/commands/view.md)
  - [vlt whoami](https://docs.vlt.io/client/commands/whoami.md)
- Migration
  - [Migrating to vlt](https://docs.vlt.io/client/migration.md)
  - [Migrating from npm to vlt](https://docs.vlt.io/client/migration/from-npm.md)
  - [Migrating from yarn to vlt](https://docs.vlt.io/client/migration/from-yarn.md)
  - [Migrating from pnpm to vlt](https://docs.vlt.io/client/migration/from-pnpm.md)
- Selectors
  - [Dependency Selector Syntax](https://docs.vlt.io/client/selectors.md)
  - [Attribute Selectors](https://docs.vlt.io/client/selectors/attribute-selectors.md)
  - [Combinators](https://docs.vlt.io/client/selectors/combinators.md)
  - [ID Selectors](https://docs.vlt.io/client/selectors/id-selectors.md)
  - [Security Insights](https://docs.vlt.io/client/selectors/security-insights.md)
  - Pseudo-classes
    - [Pseudo-class Selectors](https://docs.vlt.io/client/selectors/pseudo-classes.md)
    - [:attr()](https://docs.vlt.io/client/selectors/pseudo-classes/attr.md)
    - [:has()](https://docs.vlt.io/client/selectors/pseudo-classes/has.md)
    - [:dist()](https://docs.vlt.io/client/selectors/pseudo-classes/dist.md)
    - [:host()](https://docs.vlt.io/client/selectors/pseudo-classes/host.md)
    - [:is()](https://docs.vlt.io/client/selectors/pseudo-classes/is.md)
    - [:not()](https://docs.vlt.io/client/selectors/pseudo-classes/not.md)
    - [:outdated()](https://docs.vlt.io/client/selectors/pseudo-classes/outdated.md)
    - [:published()](https://docs.vlt.io/client/selectors/pseudo-classes/published.md)
    - [:semver()](https://docs.vlt.io/client/selectors/pseudo-classes/semver.md)
    - [:spec()](https://docs.vlt.io/client/selectors/pseudo-classes/spec.md)
    - [:path()](https://docs.vlt.io/client/selectors/pseudo-classes/path.md)
    - [:type()](https://docs.vlt.io/client/selectors/pseudo-classes/type.md)
    - [:diff()](https://docs.vlt.io/client/selectors/pseudo-classes/diff.md)
    - [:hostname()](https://docs.vlt.io/client/selectors/pseudo-classes/hostname.md)
    - [:registry()](https://docs.vlt.io/client/selectors/pseudo-classes/registry.md)
    - [:skill()](https://docs.vlt.io/client/selectors/pseudo-classes/skill.md)
  - Pseudo-states
    - [Pseudo-state Selectors](https://docs.vlt.io/client/selectors/pseudo-states.md)
- API Reference
  - [API Reference](https://docs.vlt.io/client/api-reference.md)
  - @vltpkg/cache
    - [@vltpkg/cache](https://docs.vlt.io/client/api-reference/cache.md)
    - [Reference](https://docs.vlt.io/client/api-reference/cache/reference.md)
  - @vltpkg/cache-unzip
    - [@vltpkg/cache-unzip](https://docs.vlt.io/client/api-reference/cache-unzip.md)
    - [index](https://docs.vlt.io/client/api-reference/cache-unzip/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/cache-unzip/reference.md)
    - [unzip](https://docs.vlt.io/client/api-reference/cache-unzip/unzip.md)
  - @vltpkg/cli-sdk
    - [@vltpkg/cli-sdk](https://docs.vlt.io/client/api-reference/cli-sdk.md)
    - [config](https://docs.vlt.io/client/api-reference/cli-sdk/config.md)
    - [index](https://docs.vlt.io/client/api-reference/cli-sdk/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/cli-sdk/reference.md)
    - [view](https://docs.vlt.io/client/api-reference/cli-sdk/view.md)
    - Config
      - [config/definition](https://docs.vlt.io/client/api-reference/cli-sdk/config/definition.md)
  - @vltpkg/cmd-shim
    - [@vltpkg/cmd-shim](https://docs.vlt.io/client/api-reference/cmd-shim.md)
    - [Reference](https://docs.vlt.io/client/api-reference/cmd-shim/reference.md)
  - @vltpkg/config
    - [@vltpkg/config](https://docs.vlt.io/client/api-reference/config.md)
    - [Reference](https://docs.vlt.io/client/api-reference/config/reference.md)
  - @vltpkg/dep-id
    - [@vltpkg/dep-id](https://docs.vlt.io/client/api-reference/dep-id.md)
    - [browser](https://docs.vlt.io/client/api-reference/dep-id/browser.md)
    - [index](https://docs.vlt.io/client/api-reference/dep-id/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/dep-id/reference.md)
  - @vltpkg/dot-prop
    - [@vltpkg/dot-prop](https://docs.vlt.io/client/api-reference/dot-prop.md)
    - [Reference](https://docs.vlt.io/client/api-reference/dot-prop/reference.md)
  - @vltpkg/dss-breadcrumb
    - [@vltpkg/dss-breadcrumb](https://docs.vlt.io/client/api-reference/dss-breadcrumb.md)
    - [Reference](https://docs.vlt.io/client/api-reference/dss-breadcrumb/reference.md)
  - @vltpkg/dss-parser
    - [@vltpkg/dss-parser](https://docs.vlt.io/client/api-reference/dss-parser.md)
    - [Reference](https://docs.vlt.io/client/api-reference/dss-parser/reference.md)
  - @vltpkg/error-cause
    - [@vltpkg/error-cause](https://docs.vlt.io/client/api-reference/error-cause.md)
    - [Reference](https://docs.vlt.io/client/api-reference/error-cause/reference.md)
  - @vltpkg/fast-split
    - [@vltpkg/fast-split](https://docs.vlt.io/client/api-reference/fast-split.md)
    - [Reference](https://docs.vlt.io/client/api-reference/fast-split/reference.md)
  - @vltpkg/git
    - [@vltpkg/git](https://docs.vlt.io/client/api-reference/git.md)
    - [Reference](https://docs.vlt.io/client/api-reference/git/reference.md)
  - @vltpkg/git-scp-url
    - [@vltpkg/git-scp-url](https://docs.vlt.io/client/api-reference/git-scp-url.md)
    - [Reference](https://docs.vlt.io/client/api-reference/git-scp-url/reference.md)
  - @vltpkg/graph
    - [@vltpkg/graph](https://docs.vlt.io/client/api-reference/graph.md)
    - [browser](https://docs.vlt.io/client/api-reference/graph/browser.md)
    - [index](https://docs.vlt.io/client/api-reference/graph/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/graph/reference.md)
  - @vltpkg/graph-run
    - [@vltpkg/graph-run](https://docs.vlt.io/client/api-reference/graph-run.md)
    - [Reference](https://docs.vlt.io/client/api-reference/graph-run/reference.md)
  - @vltpkg/init
    - [@vltpkg/init](https://docs.vlt.io/client/api-reference/init.md)
    - [Reference](https://docs.vlt.io/client/api-reference/init/reference.md)
  - @vltpkg/keychain
    - [@vltpkg/keychain](https://docs.vlt.io/client/api-reference/keychain.md)
    - [Reference](https://docs.vlt.io/client/api-reference/keychain/reference.md)
  - @vltpkg/output
    - [@vltpkg/output](https://docs.vlt.io/client/api-reference/output.md)
    - [error](https://docs.vlt.io/client/api-reference/output/error.md)
    - [index](https://docs.vlt.io/client/api-reference/output/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/output/reference.md)
  - @vltpkg/package-info
    - [@vltpkg/package-info](https://docs.vlt.io/client/api-reference/package-info.md)
    - [Reference](https://docs.vlt.io/client/api-reference/package-info/reference.md)
  - @vltpkg/package-json
    - [@vltpkg/package-json](https://docs.vlt.io/client/api-reference/package-json.md)
    - [Reference](https://docs.vlt.io/client/api-reference/package-json/reference.md)
  - @vltpkg/pick-manifest
    - [@vltpkg/pick-manifest](https://docs.vlt.io/client/api-reference/pick-manifest.md)
    - [Reference](https://docs.vlt.io/client/api-reference/pick-manifest/reference.md)
  - @vltpkg/promise-spawn
    - [@vltpkg/promise-spawn](https://docs.vlt.io/client/api-reference/promise-spawn.md)
    - [Reference](https://docs.vlt.io/client/api-reference/promise-spawn/reference.md)
  - @vltpkg/query
    - [@vltpkg/query](https://docs.vlt.io/client/api-reference/query.md)
    - [Reference](https://docs.vlt.io/client/api-reference/query/reference.md)
  - @vltpkg/registry-client
    - [@vltpkg/registry-client](https://docs.vlt.io/client/api-reference/registry-client.md)
    - [cache-entry](https://docs.vlt.io/client/api-reference/registry-client/cache-entry.md)
    - [index](https://docs.vlt.io/client/api-reference/registry-client/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/registry-client/reference.md)
    - [registry-error](https://docs.vlt.io/client/api-reference/registry-client/registry-error.md)
    - [store-root](https://docs.vlt.io/client/api-reference/registry-client/store-root.md)
  - @vltpkg/rollback-remove
    - [@vltpkg/rollback-remove](https://docs.vlt.io/client/api-reference/rollback-remove.md)
    - [Reference](https://docs.vlt.io/client/api-reference/rollback-remove/reference.md)
  - @vltpkg/run
    - [@vltpkg/run](https://docs.vlt.io/client/api-reference/run.md)
    - [Reference](https://docs.vlt.io/client/api-reference/run/reference.md)
  - @vltpkg/satisfies
    - [@vltpkg/satisfies](https://docs.vlt.io/client/api-reference/satisfies.md)
    - [Reference](https://docs.vlt.io/client/api-reference/satisfies/reference.md)
  - @vltpkg/security-archive
    - [@vltpkg/security-archive](https://docs.vlt.io/client/api-reference/security-archive.md)
    - [browser](https://docs.vlt.io/client/api-reference/security-archive/browser.md)
    - [index](https://docs.vlt.io/client/api-reference/security-archive/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/security-archive/reference.md)
    - [update-expired](https://docs.vlt.io/client/api-reference/security-archive/update-expired.md)
  - @vltpkg/semver
    - [@vltpkg/semver](https://docs.vlt.io/client/api-reference/semver.md)
    - [Reference](https://docs.vlt.io/client/api-reference/semver/reference.md)
  - @vltpkg/spec
    - [@vltpkg/spec](https://docs.vlt.io/client/api-reference/spec.md)
    - [browser](https://docs.vlt.io/client/api-reference/spec/browser.md)
    - [index](https://docs.vlt.io/client/api-reference/spec/module_index.md)
    - [Reference](https://docs.vlt.io/client/api-reference/spec/reference.md)
  - @vltpkg/tar
    - [@vltpkg/tar](https://docs.vlt.io/client/api-reference/tar.md)
    - [clonefile](https://docs.vlt.io/client/api-reference/tar/clonefile.md)
    - [link-tree](https://docs.vlt.io/client/api-reference/tar/link-tree.md)
    - [index](https://docs.vlt.io/client/api-reference/tar/module_index.md)
    - [pool](https://docs.vlt.io/client/api-reference/tar/pool.md)
    - [Reference](https://docs.vlt.io/client/api-reference/tar/reference.md)
    - [store-entry](https://docs.vlt.io/client/api-reference/tar/store-entry.md)
    - [store-index](https://docs.vlt.io/client/api-reference/tar/store-index.md)
    - [unpack](https://docs.vlt.io/client/api-reference/tar/unpack.md)
  - @vltpkg/types
    - [@vltpkg/types](https://docs.vlt.io/client/api-reference/types.md)
    - [Reference](https://docs.vlt.io/client/api-reference/types/reference.md)
  - @vltpkg/url-open
    - [@vltpkg/url-open](https://docs.vlt.io/client/api-reference/url-open.md)
    - [Reference](https://docs.vlt.io/client/api-reference/url-open/reference.md)
  - @vltpkg/user-agent
    - [@vltpkg/user-agent](https://docs.vlt.io/client/api-reference/user-agent.md)
    - [Reference](https://docs.vlt.io/client/api-reference/user-agent/reference.md)
  - @vltpkg/vlt-json
    - [@vltpkg/vlt-json](https://docs.vlt.io/client/api-reference/vlt-json.md)
    - [Reference](https://docs.vlt.io/client/api-reference/vlt-json/reference.md)
  - @vltpkg/vlx
    - [@vltpkg/vlx](https://docs.vlt.io/client/api-reference/vlx.md)
    - [Reference](https://docs.vlt.io/client/api-reference/vlx/reference.md)
  - @vltpkg/which
    - [@vltpkg/which](https://docs.vlt.io/client/api-reference/which.md)
    - [Reference](https://docs.vlt.io/client/api-reference/which/reference.md)
  - @vltpkg/workspaces
    - [@vltpkg/workspaces](https://docs.vlt.io/client/api-reference/workspaces.md)
    - [Reference](https://docs.vlt.io/client/api-reference/workspaces/reference.md)
  - @vltpkg/xdg
    - [@vltpkg/xdg](https://docs.vlt.io/client/api-reference/xdg.md)
    - [Reference](https://docs.vlt.io/client/api-reference/xdg/reference.md)