GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing docs.vixcpp.com — Vix.cpp Documentation

vix add

vix add adds or changes a Vix Registry dependency requirement for the current project or for one application module.

Use it when the application itself needs a package, or when an application module needs a registry package that should stay declared with that module.

bash

vix add gk/jwt

Overview

vix add is the command for declaring or changing a Vix Registry dependency requirement.

For a root project dependency, it resolves the package from the local registry index, updates vix.json, resolves the active project dependency graph, and updates the root vix.lock. In a modular vix.app project, --module stores the requirement in that module's vix.module instead. The application still has one root lockfile and one shared dependency graph.

This distinction keeps dependency ownership visible. A JWT package used only by auth can remain declared with auth, while Vix still resolves all active application and module requirements together from the project root.

text

vix add
  |
  +-- root dependency   -> vix.json
  |
  +-- module dependency -> modules/<name>/vix.module
  |
  v
resolve active dependency requirements
  |
  v
root vix.lock

1
2
3
4
5
6
7
8
9
10
11

Usage

bash

vix add [@]namespace/name[@version]
vix add [@]namespace/name[@version] --module <name>
vix add [@]namespace/name[@version] -m <name>
vix add [@]namespace/name[@version] --module <name> --link <target>

1
2
3
4

Basic examples

bash

# Add the latest available version
vix add gk/jwt

# Add a compatible version range
vix add gk/jwt@^1.0.0

# Add an exact version
vix add gk/[email protected]

# Scoped-style syntax is supported
vix add @gk/jwt

# Scoped-style syntax with a range
vix add @gk/jwt@~1.2.0

# Add the package to a module instead of the root dependency list
vix add gk/jwt@^1.0.0 --module auth

# Override the CMake target linked by that module
vix add gk/jwt@^1.0.0 --module auth --link gk::jwt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

What it does

When you run:

bash

vix add gk/jwt@^1.0.0

Vix does this:

Checks that the local registry index exists.
Parses the package spec.
Finds the package in the local registry index.
Resolves the requested version or range.
Builds the prospective root or module requirement state in memory.
Resolves the active project dependency constraints.
Fetches required package repositories at pinned commits.
Computes package content hashes.
Publishes the affected manifest and root vix.lock as one project mutation.
Prints the resolved package and dependency count.

If resolution or publication fails, Vix does not leave the manifest and lockfile describing different dependency states.

Registry requirement

vix add requires the local registry index.

If the registry has not been synced, Vix reports:

txt

registry not synced
Run: vix registry sync

1
2

Fix:

bash

vix registry sync
vix add gk/jwt

1
2

Package format

A package name uses this format:

txt

namespace/name

Examples:

txt

gk/jwt
gk/json
gaspardkirira/tree

1
2
3

Scoped-style syntax is also accepted:

txt

@namespace/name

Example:

txt

@gk/jwt

Both forms point to the same package id:

txt

gk/jwt

Version format

A package spec can include a version or version range.

bash

vix add gk/jwt
vix add gk/[email protected]
vix add gk/jwt@^1.0.0
vix add gk/jwt@~1.2.0
vix add @gk/jwt@^1.0.0

1
2
3
4
5

If no version is provided, Vix resolves the latest available version from the local registry index.

bash

vix add gk/jwt

If a range is provided, Vix resolves the highest version that satisfies that range.

bash

vix add gk/jwt@^1.0.0

Supported version behavior

vix add uses semver resolution.

Supported forms include:

txt

1.0.0
^1.0.0
~1.2.0

1
2
3

The selected version is stored exactly in vix.lock.

For root-level dependencies, the requested version or range is stored in vix.json. For module dependencies, it is stored in the module's vix.module file.

What files are updated

Without --module, vix add updates:

txt

vix.json
vix.lock

1
2

With --module, it updates:

txt

modules/<name>/vix.module
vix.lock

1
2

It does not directly edit vix.app. The module must already be declared there for the generated vix.app build to treat it as part of the application graph.

There is no per-module vix.lock. Module ownership changes where the dependency requirement is declared and which module target consumes it, while exact resolution remains in the root lockfile.

Module dependencies

Use --module when a Registry package belongs to one application module.

bash

vix add gk/jwt@^1.0.0 --module auth

The requirement is stored in the module manifest.

toml

[deps]
registry = [
  "gk/jwt@^1.0.0",
]

links = [
  "gk::jwt",
]

1
2
3
4
5
6
7
8

If --link is omitted, Vix derives the conventional CMake target from the Registry package id. For gk/jwt, that target is:

text

gk::jwt

Use an explicit target when the package exports a different target:

bash

vix add gk/jwt@^1.0.0 \
  --module auth \
  --link gk::jwt

1
2
3

When the module is active, its Registry requirement participates in the same dependency constraint analysis as root application requirements and requirements from other active modules.

The module target receives the module-owned link targets. They are not automatically attached to sibling modules or to the application target.

text

auth
  +-- gk::jwt

billing
  +-- no gk::jwt ownership

1
2
3
4
5

The Registry requirement list and CMake link list represent different information. A Registry requirement identifies what must be resolved. A link entry identifies a target consumed by the module. Do not assume that the two arrays form a positional one-to-one mapping.

After adding a module dependency:

bash

vix modules check
vix build

1
2

Module dependency constraints

Active root and module Registry requirements are analyzed together.

For example:

text

application -> gk/json@^1.0.0
auth        -> gk/json@^1.2.0

1
2

Vix selects an available version that satisfies all active compatible requirements.

If no available version can satisfy the active requirements, the operation fails instead of allowing one owner to overwrite another owner's requirement.

A disabled module can keep its Registry dependency metadata on disk. Its requirements do not constrain the active application dependency graph until the module becomes active.

Registry versus direct Git dependencies

vix add is the Registry workflow.

bash

vix add gk/jwt@^1.0.0 --module auth

For a direct Git repository, use vix install:

bash

vix install https://github.com/gabime/spdlog \
  --tag v1.15.3 \
  --target spdlog::spdlog \
  --module auth

1
2
3
4

The Git form is stored as a structured [dependencies.<name>] entry in vix.module.

Do not use vix add as a synonym for direct Git installation.

`vix.json`

vix.json stores declared dependency requirements.

The current dependency format is:

json

{
  "deps": [
    {
      "id": "gk/jwt",
      "version": "^1.0.0"
    }
  ]
}

1
2
3
4
5
6
7
8

If the dependency already exists, vix add updates its requested version.

Example:

bash

vix add gk/jwt@^1.0.0
vix add gk/jwt@~1.2.0

1
2

After the second command, the gk/jwt entry is updated instead of duplicated.

`vix.lock`

vix.lock stores the exact resolved dependency state for the application.

Root and module-owned Registry requirements resolve into this same root lockfile. Vix updates it after successful dependency resolution.

Example shape:

json

{
  "lockVersion": 1,
  "dependencies": [
    {
      "id": "gk/jwt",
      "requested": "^1.0.0",
      "version": "1.2.0",
      "repo": "https://github.com/...",
      "tag": "v1.2.0",
      "commit": "...",
      "hash": "..."
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

The lockfile is sorted by dependency id.

This keeps installs reproducible.

Transitive dependencies

vix add resolves the full project dependency graph.

If the package you add depends on other Vix packages, those dependencies are also resolved and written to vix.lock.

Example:

txt

app depends on gk/http
gk/http depends on gk/json

1
2

After:

bash

vix add gk/http

vix.lock can include:

txt

gk/http
gk/json

1
2

This is important because vix.lock represents the resolved project dependency state, not only the direct dependency you typed.

Package fetching

During resolution, Vix fetches package repositories into the global Git store.

Typical location:

txt

~/.vix/store/git/

A package is checked out at the pinned commit recorded by the registry.

This gives the lockfile stable fields such as:

txt

repo
tag
commit
hash

1
2
3
4

Content hash

After checkout, Vix computes a package content hash.

That hash is written into vix.lock.

The goal is to make package state verifiable and reproducible.

Output

Example output shape:

txt

resolved: gk/[email protected]

Add
id: gk/jwt
version: 1.2.0
tag: v1.2.0
commit: 8f3a...

resolving project dependencies...
✔ added: gk/[email protected]
✔ lock:  /home/user/api/vix.lock
✔ deps:  3

1
2
3
4
5
6
7
8
9
10
11
12

The deps count is the number of resolved locked dependencies after the full graph resolution.

Package not found

If a package is not found, Vix searches the local registry index using the package name.

Example:

bash

vix add gk/unknown

Output shape:

txt

package not found: gk/unknown

Search
query: "unknown"

No matches found in the local registry index.

If you just updated the registry, run: vix registry sync

1
2
3
4
5
6
7
8

If matching packages exist, Vix prints local search results.

Invalid package spec

Valid:

bash

vix add gk/jwt
vix add @gk/jwt
vix add gk/[email protected]
vix add @gk/jwt@^1.0.0

1
2
3
4

Invalid:

bash

vix add jwt
vix add gk
vix add @/jwt
vix add gk/jwt@

1
2
3
4

If the spec is invalid, Vix reports:

txt

invalid package spec
Expected: <namespace>/<name>[@<version>]
Example:  vix add gaspardkirira/tree
Example:  vix add gaspardkirira/[email protected]
Try search: vix search <input>

1
2
3
4
5

Version not found

If the requested version or range cannot be resolved, Vix reports an error.

Example:

bash

vix add gk/[email protected]

Output shape:

txt

no version matches range: gk/[email protected]

If a resolved version is missing from the registry entry, Vix can show available versions and suggest the latest version.

Add latest version

bash

vix add gk/jwt

This resolves the latest version from the local registry index.

For a root-level dependency, the resolved exact version is stored in both vix.json and vix.lock. For a module dependency, the module manifest receives the dependency spec and the root lockfile receives the resolved exact version.

For no-version input, the requested version becomes the resolved exact version.

Example result:

json

{
  "deps": [
    {
      "id": "gk/jwt",
      "version": "1.2.0"
    }
  ]
}

1
2
3
4
5
6
7
8

Add a version range

bash

vix add gk/jwt@^1.0.0

For a root-level dependency, this stores the declared range in vix.json:

json

{
  "deps": [
    {
      "id": "gk/jwt",
      "version": "^1.0.0"
    }
  ]
}

1
2
3
4
5
6
7
8

And stores the exact resolved version in vix.lock:

json

{
  "id": "gk/jwt",
  "requested": "^1.0.0",
  "version": "1.2.0"
}

1
2
3
4
5

Add an exact version

bash

vix add gk/[email protected]

For a root-level dependency, this stores:

json

{
  "deps": [
    {
      "id": "gk/jwt",
      "version": "1.0.0"
    }
  ]
}

1
2
3
4
5
6
7
8

And locks:

json

{
  "id": "gk/jwt",
  "requested": "1.0.0",
  "version": "1.0.0"
}

1
2
3
4
5

Add a scoped package

bash

vix add @gk/jwt

This is normalized to:

txt

gk/jwt

The @ form is supported for users who prefer scoped package syntax.

After adding a dependency

After vix add, build the project.

bash

vix build

For development:

bash

vix dev

For validation:

bash

vix check --tests

If the dependency exposes headers or targets, you must still use it from your project.

Using the dependency in `vix.app`

For root-level dependencies, vix add updates vix.json and vix.lock.

For vix.app projects, also add the package target alias to links when the application target uses the package directly. If the package belongs to a module, use vix add --module instead and keep the link target in modules/<name>/vix.module.

Example dependency:

bash

vix add gk/json@^1.0.0

Then in vix.app:

ini

deps = [
  gk/json@^1.0.0,
]

links = [
  vix::vix,
  gk::json,
]

1
2
3
4
5
6
7
8

The registry package spec goes in:

txt

deps

The CMake target alias goes in:

txt

links

`deps` in `vix.json` vs `deps` in `vix.app`

There are two places you may see dependency declarations.

vix.json is the package management manifest used by vix add, vix update, and vix install.

Example:

json

{
  "deps": [
    {
      "id": "gk/json",
      "version": "^1.0.0"
    }
  ]
}

1
2
3
4
5
6
7
8

vix.app is the app build manifest.

Example:

ini

deps = [
  gk/json@^1.0.0,
]

1
2
3

The project dependency manager uses vix.json.

The app build manifest uses vix.app.

Keep them aligned when using vix.app.

Using the dependency in CMake

For a manual CMake project, include the generated dependency integration after install.

cmake

include(.vix/vix_deps.cmake)

target_link_libraries(api PRIVATE
  gk::json
)

1
2
3
4
5

A normal flow is:

bash

vix add gk/json@^1.0.0
vix install
vix build

1
2
3

Difference between `vix add` and `vix install`

The commands overlap in dependency workflows, but they do different jobs.

Command	Purpose
`vix add <pkg>`	Add or change a Vix Registry requirement.
`vix add <pkg> --module <name>`	Add or change a Registry requirement owned by one module.
`vix install`	Materialize the dependency state already described by project manifests and `vix.lock`.
`vix install <git-url>`	Add a direct Git dependency to the application.
`vix install <git-url> --module <name>`	Add a direct Git dependency owned by one module.

Use vix add when the dependency comes from the Vix Registry.

Use vix install <git-url> when the dependency is a direct Git repository.

After cloning an existing project, a normal reproducible workflow is:

bash

vix install
vix build

1
2

Difference between `vix add` and `vix update`

Command	Purpose
`vix add <pkg>`	Add or change one dependency requirement.
`vix update`	Re-resolve project dependencies and rewrite `vix.lock`.

Use vix update when you want to refresh existing locked versions.

Difference between `vix add` and `vix search`

Command	Purpose
`vix search <query>`	Search the local registry index.
`vix add <pkg>`	Add a package by exact registry id.

If you do not know the exact package name, search first:

bash

vix search jwt
vix add gk/jwt

1
2

Atomic dependency updates

vix add updates project dependency metadata through one project mutation boundary.

For a root dependency, the relevant authoritative files are:

text

vix.json
vix.lock

1
2

For a module dependency:

text

modules/<name>/vix.module
vix.lock

1
2

Vix resolves the prospective dependency state before publishing the new metadata. If resolution, repository materialization, or metadata publication fails, the previous project state is preserved.

Project mutations are serialized so concurrent Vix commands cannot silently overwrite the same dependency metadata.

Full workflow

bash

vix registry sync
vix search jwt
vix add gk/jwt@^1.0.0
vix install
vix build
vix tests

1
2
3
4
5
6

For development:

bash

vix dev

CI workflow

After dependencies are committed:

bash

vix registry sync
vix install
vix build --build-target all
vix tests

1
2
3
4

vix add is usually not used in CI.

CI should use:

bash

vix install

because CI should install the exact versions from vix.lock.

Options

vix add takes one package spec. By default it writes a root dependency; with --module, it writes the dependency to a module manifest instead.

bash

vix add [@]namespace/name[@version]
vix add [@]namespace/name[@version] --module <name>
vix add [@]namespace/name[@version] -m <name>
vix add [@]namespace/name[@version] --module <name> --link <target>

1
2
3
4

Option	Description
`-m, --module <name>`	Add the dependency to `modules/<name>/vix.module` instead of the root dependency list.
`--link <target>`	Set the CMake target linked by the module dependency.
`-h, --help`	Show help.

Commands reference

Command	Description
`vix add gk/jwt`	Add latest available version to the root dependency list.
`vix add gk/[email protected]`	Add exact version.
`vix add gk/jwt@^1.0.0`	Add compatible range.
`vix add @gk/jwt`	Add using scoped-style syntax.
`vix add gk/jwt@^1.0.0 --module auth`	Add the dependency to the `auth` module.
`vix add gk/jwt@^1.0.0 --module auth --link gk::jwt`	Add the dependency to `auth` with an explicit CMake link target.

Common workflows

Add latest package

bash

vix registry sync
vix add gk/jwt
vix install
vix build

1
2
3
4

Add compatible range

bash

vix add gk/jwt@^1.0.0
vix install
vix check --tests

1
2
3

Add exact version

bash

vix add gk/[email protected]
vix install
vix build

1
2
3

Search before adding

bash

vix search jwt
vix add gk/jwt

1
2

Add and validate

bash

vix add gk/jwt
vix install
vix check --tests

1
2
3

Add a Registry package to one module

bash

vix add gk/jwt@^1.0.0 --module auth
vix modules check
vix build

1
2
3

For a direct Git dependency owned by the module, use vix install <git-url> --module auth instead.

Common mistakes

Forgetting to sync the registry

Wrong:

bash

vix add gk/jwt

when the registry has not been synced.

Correct:

bash

vix registry sync
vix add gk/jwt

1
2

Using a package name without namespace

Wrong:

bash

vix add jwt

Correct:

bash

vix add gk/jwt

Expecting `vix add` to update every dependency

vix add adds or changes one dependency requirement.

To refresh existing locked versions, use:

bash

vix update

Expecting `vix add` to only update `vix.json`

vix add also rewrites vix.lock. With --module, it updates modules/<name>/vix.module instead of adding the dependency directly to vix.json.

It resolves the whole project dependency graph after updating the root manifest or the module manifest.

Expecting `vix add` to automatically edit `vix.app`

vix add updates package metadata. It does not add root vix.app link entries automatically.

For root-level vix.app dependencies, add the target alias to links when you need to link it. For module-level dependencies, use vix add --module so the link target is written to the module manifest.

Example:

ini

links = [
  vix::vix,
  gk::json,
]

1
2
3
4

Using `vix add` for a direct Git repository

vix add resolves Vix Registry package ids.

For a Registry package:

bash

vix add gk/jwt@^1.0.0 --module auth

For a direct Git repository:

bash

vix install https://github.com/gabime/spdlog \
  --tag v1.15.3 \
  --target spdlog::spdlog \
  --module auth

1
2
3
4

Creating a per-module lockfile

Do not create modules/<name>/vix.lock.

The root vix.lock is the exact dependency state for the whole application, including active module-owned dependencies.

Confusing package specs and CMake aliases

Package spec:

txt

gk/json@^1.0.0

CMake alias:

txt

gk::json

Use package specs in dependency declarations.

Use aliases in links or target_link_libraries.

Editing `vix.lock` manually

Do not manually edit vix.lock.

Use:

bash

vix add
vix update
vix remove

1
2
3

to change dependency state.

Troubleshooting

Registry not synced

Run:

bash

vix registry sync

Then:

bash

vix add gk/jwt

Package not found

Search locally:

bash

vix search jwt

Then add the exact package id:

bash

vix add gk/jwt

If the package should exist, refresh the registry:

bash

vix registry sync

Invalid package spec

Use:

txt

namespace/name
namespace/name@version
@namespace/name
@namespace/name@version

1
2
3
4

Examples:

bash

vix add gk/jwt
vix add @gk/jwt@^1.0.0

1
2

No version matches range

If Vix reports:

txt

no version matches range: gk/jwt@^2.0.0

choose a range that exists in the registry.

Check available versions through the registry or package listing tools.

Version not found

If Vix reports that the resolved version is not found in the registry entry, sync the registry again:

bash

vix registry sync

Then retry.

Git clone failed

Vix fetches package source from the repository URL stored in the registry entry.

Check:

network connection
repository URL
Git authentication if private
registry metadata

Then retry:

bash

vix add gk/jwt

Git checkout failed

The registry entry points to a commit that could not be checked out.

This usually means registry metadata is stale or invalid.

Run:

bash

vix registry sync

If the issue remains, the registry entry needs correction.

Add failed while resolving transitive dependencies

A transitive dependency may be missing, invalid, or impossible to resolve.

Run:

bash

vix registry sync
vix add <package>

1
2

If it still fails, inspect the dependency package’s vix.json.

Best practices

Run vix registry sync before adding Registry packages when the local index may be stale.

Use vix search when you do not know the exact Registry package id.

Use version ranges when compatible updates are acceptable. Use exact versions when the project requires an exact declared requirement.

Keep dependencies owned by the narrowest appropriate scope. If only auth needs a Registry package, prefer:

bash

vix add gk/jwt@^1.0.0 --module auth

Do not create per-module lockfiles or caches.

Commit the dependency manifests and root vix.lock.

Do not edit vix.lock manually.

Run module checks after changing module-owned dependencies:

bash

vix modules check
vix build

1
2

Use vix install <git-url> for direct Git dependencies rather than treating Git repositories as Registry package ids.

Related commands

Command	Purpose
`vix search`	Search the local Registry index.
`vix install`	Materialize locked dependencies or add a direct Git dependency.
`vix modules`	Manage and validate application modules.
`vix update`	Re-resolve Registry dependency versions.
`vix outdated`	Check outdated Registry dependencies.
`vix remove`	Remove dependencies.
`vix list`	List dependency state.
`vix registry sync`	Refresh the local Registry index.
`vix build`	Build after dependency changes.
`vix tests`	Run tests after dependency changes.

Next step

Install locked dependencies.

Open the vix install guide

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

vix add ​

Overview ​

Usage ​

Basic examples ​

What it does ​

Registry requirement ​

Package format ​

Version format ​

Supported version behavior ​

What files are updated ​

Module dependencies ​

Module dependency constraints ​

Registry versus direct Git dependencies ​

vix.json ​

vix.lock ​

Transitive dependencies ​

Package fetching ​

Content hash ​

Output ​

Package not found ​

Invalid package spec ​

Version not found ​

Add latest version ​

Add a version range ​

Add an exact version ​

Add a scoped package ​

After adding a dependency ​

Using the dependency in vix.app ​

deps in vix.json vs deps in vix.app ​

Using the dependency in CMake ​

Difference between vix add and vix install ​

Difference between vix add and vix update ​

Difference between vix add and vix search ​

Atomic dependency updates ​

Full workflow ​

CI workflow ​

Options ​

Commands reference ​

Common workflows ​

Add latest package ​

Add compatible range ​

Add exact version ​

Search before adding ​

Add and validate ​

Add a Registry package to one module ​

Common mistakes ​

Forgetting to sync the registry ​

Using a package name without namespace ​

Expecting vix add to update every dependency ​

Expecting vix add to only update vix.json ​

Expecting vix add to automatically edit vix.app ​

Using vix add for a direct Git repository ​

Creating a per-module lockfile ​

Confusing package specs and CMake aliases ​

Editing vix.lock manually ​

Troubleshooting ​

Registry not synced ​

Package not found ​

Invalid package spec ​

No version matches range ​

Version not found ​

Git clone failed ​

Git checkout failed ​

Add failed while resolving transitive dependencies ​

Best practices ​

Related commands ​

Next step ​

vix add

Overview

Usage

Basic examples

What it does

Registry requirement

Package format

Version format

Supported version behavior

What files are updated

Module dependencies

Module dependency constraints

Registry versus direct Git dependencies

`vix.json`

`vix.lock`

Transitive dependencies

Package fetching

Content hash

Output

Package not found

Invalid package spec

Version not found

Add latest version

Add a version range

Add an exact version

Add a scoped package

After adding a dependency

Using the dependency in `vix.app`

`deps` in `vix.json` vs `deps` in `vix.app`

Using the dependency in CMake

Difference between `vix add` and `vix install`

Difference between `vix add` and `vix update`

Difference between `vix add` and `vix search`

Atomic dependency updates

Full workflow

CI workflow

Options

Commands reference

Common workflows

Add latest package

Add compatible range

Add exact version

Search before adding

Add and validate

Add a Registry package to one module

Common mistakes

Forgetting to sync the registry

Using a package name without namespace

Expecting `vix add` to update every dependency

Expecting `vix add` to only update `vix.json`

Expecting `vix add` to automatically edit `vix.app`

Using `vix add` for a direct Git repository

Creating a per-module lockfile

Confusing package specs and CMake aliases

Editing `vix.lock` manually

Troubleshooting

Registry not synced

Package not found

Invalid package spec

No version matches range

Version not found

Git clone failed

Git checkout failed

Add failed while resolving transitive dependencies

Best practices

Related commands

Next step