Introduction to the website

The purpose of this website is to provide documentation and updates on Viash, a tool that lets you turn scripts into reusable components.

The purpose of this website is to provide documentation and updates on Viash, a tool that lets you turn scripts into reusable components. This blog post aims to help you guide you in the right direction for your first steps.

Introduction to Viash #

The Introduction page acts as a starting point to the rest of the documentation. You can find instructions on how to download and run Viash on the Installation page.
For a hands-on experience with Viash, take a look at the What is a Viash Component? page for a step-by-step tutorial.

Creating a config file #

Understanding how to create a configuration file is essential when you want to create your own components:

• For a general overview of the sections of the file config, take a look at the Config File page.
• The Functionality page explains the section of the same name.

Each supported executable platform has its own page explaining how to set up the Platform section of the config file:

• Native
• Docker
• Nextflow

Commands #

Every command to run, build and test components and namespaces is detailed on these pages:

• viash run
• viash build
• viash test
• viash config view
• viash ns build
• viash ns test
• viash ns list

Contributing to Viash #

If you want to contribute to Viash in any way, read the contributing guidelines and check out our code of conduct.