This is the command line tooling for Vector development.
Table of Contents:
This assumes that you have the following tools installed:
- cargo-nextest - https://nexte.st/
Run the following command from the root of the Vector repository:
cargo install -f --path vdev
Setting the path to the repository explicitly allows the application to be used at any time no matter the current working directory.
vdev config set repo .
To test, enter your home directory and then run:
vdev exec ls
A custom command for the Starship prompt is available.
format = """
...
${custom.vdev}\
...
$line_break\
...
$character"""
# <clipped>
[custom.vdev]
command = "vdev meta starship"
when = true
# Windows
# shell = ["cmd", "/C"]
# Other
# shell = ["sh", "--norc"]The CLI uses Clap with the derive construction mechanism and is stored in the commands directory.
Every command group/namespace has its own directory with a cli module, including the root vdev command group. All commands have an exec method that provides the actual implementation, which in the case of command groups will be calling sub-commands.
Unit tests can be run by calling cargo vdev test.
Integration tests are not run by default when runningcargo vdev test. Instead, they are accessible via the integration subcommand (example: cargo vdev int test aws runs aws-related integration tests). You can find the list of available integration tests using cargo vdev int show. Integration tests require docker or podman to run.