The Jackrabbit FileVault tool (VLT) is a tool developed by The Apache Foundation that maps the content of a Jackrabbit/AEM instance to your file system. The VLT tool has similar functions as source control system client (such as a Subversion (SVN) client), providing normal check-in, check-out and management operations, as well as configuration options for flexible representation of the project content.

You run the VLT tool from the command line. This document describes how to use the tool, including how to get started and get help, as well as a list of all commands and available options.

Installing the vlt tool

To use the VLT tool, you first need to install it. It is not installed by default and is an additional tool available in the /opt folder of your AEM instance. In addition, you need to set your system's environment variable.

Copy the FileVault archive file from the cq-quickstart/opt/filevault directory of your installation. Copy either filevalut.tgz or filevault.zip, depending on your operating system.

You can also download the latest version of FileVault from Package Share.

Extract the archive.

Add <archive-dir>/vault-cli-<version>/bin to your environment PATH so that the command files vlt or vlt.bat are accessed as appropriate.

For example, <aem-installation-dir>/crx-quickstart/opt/helpers/vault-cli-3.1.16/bin>

Open a command line shell and execute vlt --help. Make sure it displays the following help screen:

After you have installed it you need to update global ignored subversion files. Edit your svn settings and add the following:

[miscellany]
### Set global-ignores to a set of whitespace-delimited globs
### which Subversion will ignore in its 'status' output, and
### while importing or adding files and directories.
global-ignores = .vlt

Configuring the End of Line Character

VLT automatically handles End Of Line (EOF) according to the following rules:

lines of files checked out on Windows end with a CRLF

lines of files checked out on Unices end with a LF

lines of files commited to the repository end with a LF

To guarantee that VLT and SVN configuration match, you should set up the svn:eol-style property to native for the extension of the files stored in the repository. Edit your svn settings and add the following:

Checking out the repository

Check out the repository using the source control system. In svn, for example, type the following (substituting the URI and path with your repository):

svn co http://svn.server.com/repos/myproject

Synchronizing with the repository

You need to synchronize filevault with the repository. To do this:

In the command line, navigate to content/jcr_root.

Check out the repository by typing the following (substituting your port number for 4502 and your admin passwords):

vlt --credentials admin:admin co --force http://localhost:4502/crx

Bemærk:

The credentials have to be specified only once upon your initial checkout. They will then be stored in your home directory inside .vault/auth.xml.

Testing whether the synchronization worked

After you have checked out the repository and synchronized it, you should test to make sure everything functions properly. An easy way to do this is to edit a .jsp file and see whether your changes are reflected after committing the changes.

To test the synchronization:

Navigate to .../jcr_content/libs/foundation/components/text.

Edit something in text.jsp.

See the modified files by typing vlt st

See the changes by typing vlt diff text.jsp

Commit the changes: vlt ci test.jsp.

Reload a page containing a text component and see whether your changes are there.

Getting Help with the VLT Tool

After installing the VLT tool, you can access its Help file from the command line:

vlt --help
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Jackrabbit FileVault [version 3.1.16] Copyright 2013 by Apache Software Foundation. See LICENSE.txt for more information.
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Usage:
vlt [options] <command> [arg1 [arg2 [arg3] ..]]
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Global options:
-Xjcrlog <arg> Extended JcrLog options (omit argument for help)
-Xdavex <arg> Extended JCR remoting options (omit argument for help)
--credentials <arg> The default credentials to use
--update-credentials if present the credentials-to-host list is updated in the ~/.vault/auth.xml
--config <arg> The JcrFs config to use
-v (--verbose) verbose output
-q (--quiet) print as little as possible
--version print the version information and exit
--log-level <level> the log4j log level
-h (--help) <command> print this help
Commands:
export Export the Vault filesystem
import Import a Vault filesystem
checkout (co) Checkout a Vault file system
status (st) Print the status of working copy files and directories.
update (up) Bring changes from the repository into the working copy.
info Displays information about a local file.
commit (ci) Send changes from your working copy to the repository.
revert (rev) Restore pristine working copy file (undo most local edits).
resolved (res) Remove 'conflicted' state on working copy files or directories.
propget (pg) Print the value of a property on files or directories.
proplist (pl) Print the properties on files or directories.
propset (ps) Set the value of a property on files or directories.
add Put files and directories under version control.
delete (del,rm) Remove files and directories from version control.
diff (di) Display the differences between two paths.
rcp Remote copy of repository content.
sync Control vault sync service
console Run an interactive console
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

For help on a particular command, type the help command followed by the name of the command. For example:

Common Tasks Performed in VLT

The following are some common tasks performed in VLT. For detailed information on each command see the individual commands.

Checking out a subtree

If you only want to check out a subtree of the repository for example, /apps/geometrixx, you can do so by typing the following:

vlt co http://localhost:4502/crx/-/jcr:root/apps/geometrixx geo

Doing this creates a new export root geo with a META-INF and jcr_root directory and puts all files below /apps/geometrixx in geo/jcr_root.

Performing a filtered checkout

If you have an existing workspace filter and you want to use it for checkout, you can either first create the META-INF/vault directory and place the filter there, or specify it on the command line as follows:

Using VLT

Options and commands are described in detail in the following sections.

VLT Global Options

The following is a list of VLT options, which are available for all commands. See the individual commands for information on additional available options.

Option

Description

-Xjcrlog <arg>

Extended JcrLog options

-Xdavex <arg>

Extended JCR remoting options

--credentials <arg>

The default credentials to use

--config <arg>

The JcrFs config to use

-v (--verbose)

verbose output

-q (--quiet)

print as little as possible

--version

Prints the version information and exits VLT

--log-level <level>

Indicates the log level, for example, the log4j log level.

-h (--help) <command>

Prints help for that particular command

VLT Commands

The following table describes all available VLT commands. See the individual commands for detailed information on syntax, available options, and examples.

Command

Abbreviated Command

Description

export

Exports from a JCR repository (vault file system) to the local file system without control files.

import

Imports a local file system to a JCR repository (vault file system).

checkout

co

Checks out a Vault file system. Use this for an initial JCR repository to the local file system. (Note: You must first check out the repository in subversion.)

analyze

Analyzes packages.

status

st

Prints the status of working copy files and directories.

update

up

Imports changes from the repository into the working copy.

info

Displays information about a local file.

commit

ci

Sends changes from your working copy to the repository.

revert

rev

Restores the working copy file to its original state and undoes most local edits.

resolved

res

Removes conflicted state on working copy files or directories.

propget

pg

Prints the value of a property on files or directories.

proplist

pl

Prints the properties on files or directories.

propset

ps

Sets the value of a property on files or directories.

add

Puts files and directories under version control.

delete

del or rm

Removes files and directories from version control.

diff

di

Displays the differences between two paths.

console

Runs an interactive console.

rcp

Copies a node tree from one remote repository to another.

sync

Allows to control the vault sync service.

Export

Exports the Vault filesystem mounted at <uri> to the local filesystem at <local-path>. An optional <jcr-path> can be specified in order to export just a sub-tree.

Syntax

export -v|-t <arg>|-p <uri> <jcr-path> <local-path>

Options

-v (--verbose)

verbose output

-t (--type) <arg>

specifies the export type, either platform or jar.

-p (--prune-missing)

specifies if missing local files should be deleted

<uri>

mountpoint uri

<jcrPath>

JCR path

<localPath>

local path

Examples

vlt export http://localhost:4502/crx /apps/geometrixx myproject

Import

Imports the local file system (starting at <local-path> to the vault file system at <uri>. You can specify a <jcr-path>as import root. If --sync is specified, the imported files are automatically put under vault control.

Syntax

import -v|-s <uri> <local-path> <jcr-path>

Options

-v (--verbose)

verbose output

-s (-- sync)

puts the local files under vault control

<uri>

mountpoint uri

<jcrPath>

JCR path

<localPath>

local path

Examples

vlt import http://localhost:4502/crx . /

Checkout (co)

Performs an initial check out from a JCR repository to the local filesystem starting at <uri> to the local filesystem at <local-path>. You can also add a <jcrPath> argument to check out a sub-directory of the remote tree. Workspace filters can be specified that are copied into the META-INF directory.

Status

If --show-update is specified, each file is checked against the remote version. The second letter then specifies what action would be performed by an update operation.

Syntax

status -v|-q|-u|-N <file1> [<file2> ...]

Options

-v (--verbose)

verbose output

-q (--quiet)

prints as little as possible

-u (--show-update)

displays update information

-N (--non-recursive)

operates on a single directory

<file> [<file> ...]

file or directory to display the status

Update

Copies changes from the repository into the working copy.

Syntax

update -v|-q|--force|-N <file1> [<file2> ...]

Options

-v (--verbose)

verbose output

-q (--quiet)

prints as little as possible

--force

forces the overwrite of local files

-N (--non-recursive)

operates on a single directory

<file> [<file> ...]

file or directory to update

Info

Displays information about a local file.

Syntax

info -v|-q|-R <file1> [<file2> ...]

Options

-v (--verbose)

verbose output

-q (--quiet)

prints as little as possible

-R (--recursive)

operates recursive

<file> [<file> ...]

file or directory to display info

Commit

Sends changes from your working copy to the repository.

Syntax

commit -v|-q|--force|-N <file1> [<file2> ...]

Options

-v (--verbose)

verbose output

-q (--quiet)

prints as little as possible

--force

forces committing even if the remote copy is modified

-N (--non-recursive)

operates on a single directory

<file> [<file> ...]

file or directory to commit

Revert

Restores working copy file to original state and undoes most local edits.

Syntax

revert -q|-R <file1> [<file2> ...]

Options

-q (--quiet)

prints as little as possible

-R (--recursive)

descends recursively

<file> [<file> ...]

file or directory to commit

Resolved

Removes conflicted state on working copy files or directories.

Bemærk:

This command does not semantically resolve conflicts or remove conflict markers; it merely removes the conflict-related artifact files and allows PATH to be committed again.

Syntax

resolved -q|-R|--force <file1> [<file2> ...]

Options

-q (--quiet)

prints as little as possible

-R (--recursive)

descends recursively

--force

resolves, even if there are conflict markers

<file> [<file> ...]

file or directory to resolve

Propget

Prints the value of a property on files or directories.

Syntax

propget -q|-R <propname> <file1> [<file2> ...]

Options

-q (--quiet)

prints as little as possible

-R (--recursive)

descends recursively

<propname>

the property name

<file> [<file> ...]

file or directory to get the property from

Proplist

Prints the properties on files or directories.

Syntax

proplist -q|-R <file1> [<file2> ...]

Options

-q (--quiet)

prints as little as possible

-R (--recursive)

descends recursively

<file> [<file> ...]

file or directory to list the properties from

Propset

Sets the value of a property on files or directories.

Bemærk:

VLT recognizes the following special versioned properties: vlt:mime-type

The mimetype of the file. Used to determine whether to merge the file. A mimetype beginning with 'text/' (or an absent mimetype) is treated as text. Anything else is treated as binary.

Syntax

propset -q|-R <propname> <propval> <file1> [<file2> ...]

Options

-q (--quiet)

prints as little as possible

-R (--recursive)

descends recursively

<propname>

the property name

<propval>

the property value

<file> [<file> ...]

file or directory to set the property to

Add

Puts files and directories under version control, scheduling them for addition to repository. They will be added on next commit.

Syntax

add -v|-q|-N|--force <file1> [<file2> ...]

Options

-v (--verbose)

verbose output

-q (--quiet)

prints as little as possible

-N (--non-recursive)

operates on a single directory

--force

forces the operation to run

<file> [<file> ...]

local file or directory to add

Delete

Removes files and directories from version control.

Syntax

delete -v|-q|--force <file1> [<file2> ...]

Options

-v (--verbose)

verbose output

-q (--quiet)

prints as little as possible

--force

forces the operation to run

<file> [<file> ...]

local file or directory to delete

Diff

Displays the differences between two paths.

Syntax

diff -N <file1> [<file2> ...]

Options

-N (--non-recursive)

operates on a single directory

<file> [<file> ...]

file or directory to display the differences from

Console

Runs an interactive console.

Syntax

console -F <file>

Options

-F (--console-settings) <file>

specifies the console settings file. The default file is console.properties.

Rcp

Copies a node tree from one remote repository to another. <src> points to the source node and <dst> specifies the destination path, where the parent node must exist. Rcp processes the nodes by streaming the data.

Examples

The --exclude options need to be followed by another option before the <src> and <dst> arguments.
For example:vlt rcp -e ".*\.txt" -r

Sync

Allows to control the vault sync service. Without any arguments this command tries to put the current working directory under sync control. If executed within a vlt checkout, it uses the respective filter and host to configure the synchronization. If executed outside of a vlt checkout, it registers the current folder for synchronization only if the directory is empty.

Syntax

sync -v|--force|-u <uri> <command> <localPath>

Options

-v (--verbose)

verbose output.

--force

force certain commands to execute.

-u (--uri) <uri>

specifies the URI of the sync host.

<command>

sync command to execute.

<localPath>

local folder to sync.

Status Codes

The status codes used by VLT are:

' ' no modifications

'A' Added

'C' Conflicted

'D' Deleted

'I' Ignored

'M' Modified

'R' Replaced

'?' item is not under version control

'!' item is missing (removed by non-svn command) or incomplete

'~' versioned item obstructed by some item of a different kind

Setting up FileVault sync

This section describes the new synchronization feature shipped with FileVault tool (vlt) since the version 2.4.24.

The vault sync service is used to synchronize repository content with a local filesystem representation and vice versa. This is achieved by installing an OSGi service that will listen for repository changes and will scan the filesystem content periodically. It uses the same serialization format as vault for mapping the repository content to disk.

Bemærk:

The vault sync service is a development tool and it is highly discouraged to use it on a productive system. Also note that the service can only sync with the local filesystem and cannot be used for remote development.

Installing the service using vlt

The vlt sync install command can be used to install the vault sync service bundle and configuration automatically.

The bundle is installed below /libs/crx/vault/install and the config node is created at /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl. Initially the service is enabled but no sync roots are configured.

The following example installs the sync service to the CRX instance accessible by the given uri.

$ vlt sync
Connecting via JCR remoting to http://localhost:4502/crx/server
Starting initialization of sync service in existing vlt checkout /Users/colligno/Applications/cq5/vltsync/sandbox/dev/jcr_root for http://localhost:4502/crx/server/-/jcr:root
Added new sync directory: /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root
The directory /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root is now enabled for syncing.
You might perform a 'sync-once' by setting the
appropriate flag in the /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/.vlt-sync-config.properties file.

Edit the .vlt-sync-config.properties hidden file and configure sync to synchronize the content of your repository:

sync-once=JCR2FS

Bemærk:

This step downloads the whole repository according to your filter configuration.

Your local folder is now synchronized with the repository. The synchronization is bi-directionnal so modification from the repository will be applied to you local sync folder and vice versa.

Bemærk:

The VLT Sync feature only supports simple files and folders but detects special vault serialized files (.content.xml, dialog.xml, etc) and ignores them silently. Thus it is possible to use vault sync on a default vlt checkout.