Common commands

Below is a list of common Viash commands to develop and test components. Please visit the Viash guide or reference documentation for more in-depth information.

Caution

Most common commands are wrapped in scripts in the scripts/ directory. You can run these from the root of the project. Some scripts accept additional arguments documented inside the script itself.

Download test data

Download all test resources from the S3 bucket into resources_test/:

scripts/create_datasets/test_resources.sh

Build all components

Build all components in a namespace:

scripts/project/build_all_components.sh

viash ns build --parallel

Build all Docker containers

Build all Docker containers:

scripts/project/build_all_docker_containers.sh

viash ns build --parallel --setup cachedbuild

Test a component

Test one component:

viash test path/to/config.vsh.yaml

Run all tests in a task:

scripts/project/test_all_components.sh

viash ns test --parallel

Edit script

Auto-generate the VIASH START/VIASH END placeholder in your script:

viash config inject path/to/config.vsh.yaml

Run a component

Display the help text of a component:

viash run path/to/config.vsh.yaml -- --help

Run a component with arguments:

viash run path/to/config.vsh.yaml -- --input dataset.h5ad --output output.h5ad

View Dockerfile

View the Dockerfile generated for a component:

viash run path/to/config.vsh.yaml -engine docker -- ---dockerfile