Warning

The product is in closed beta and not open to the public.

mod

vb mod SUBCOMMAND [ARGS...]

Description

Manage Git-backed source mod declared in the versionable git-modules setting using a .gitmodules-style format.

Subcommands

vb mod status

vb mod status

Description

Report whether local mod directories match git-modules. With -v, show individual file changes for dirty mod in a format similar to git status –short.

vb mod sync

vb mod sync [OPTIONS] [TARGET ...]

Description

Materialize or update all mod, or only the named targets. Git transfer and checkout progress is shown on a single terminal status line with the current mod number and path when stdout is a terminal.

If a target directory exists but is not a Git worktree, sync stops for that mod and reports how to retry. Use –force-sync to move such unmanaged directories aside to PATH.unmanaged-TIMESTAMP before syncing the mod into PATH. The unmanaged directory is not deleted.

Options

-f, --force

Overwrite dirty Git worktrees.

--force-sync

Move unmanaged mod directories aside.

--clean

With –force, remove untracked files.

--ignore-untracked

Do not treat untracked files as dirty.

vb mod add

vb mod add URL PATH [OPTIONS]

Description

Add a new mod declaration to the git-modules setting. The setting file .vb-settings/git-modules is updated in place.

Options

--name NAME

Logical name (defaults to PATH).

-b, --branch BRANCH

Track this branch.

--revision REV

Pin to a specific revision.

vb mod update

vb mod update NAME [OPTIONS]

Description

Update an existing mod declaration. NAME can be either the logical name or the path.

Options

--name NAME

Rename the logical mod name.

--path PATH

Change the mod path.

--url URL

Change the Git source URL.

-b, --branch BRANCH

Track this branch.

--revision REV

Pin to a specific revision.

--unset-branch

Remove the branch field.

--unset-revision

Remove the revision field.

vb mod remove

vb mod remove NAME [OPTIONS]

Description

Remove a mod declaration from the git-modules setting. NAME can be either the logical name or the path.

Options

--hard

Also delete the mod directory on disk.

vb mod credential

vb mod credential --clear NAME

Description

Clear locally cached credentials for a mod. When a remote repository password or token has changed, subsequent sync attempts using the old stored credential will fail. This command removes the cached credential so the next sync will prompt for new credentials.

NAME can be either the logical name or the path.