Viaduct Archfile Lint

This library is here to help validate the contents of a Viaduct Archfile.

What is an Archfile?

An Archfile is a system specification for an application. It belongs in the root of an application and Viaduct will use its contents to determine how it should be deployed when it is set up. They are only used for initial provisioning into the Viaduct system.

A new Archfile for a running application can be downloaded at anytime.

What does an Archfile look like?

An Archfile is a YAML document which contains a number of properties. The best place to determine what it looks like would be to refer to our examples.

How can I test the validity of an Archfile?

To test that your Archfile is appropriate, you can install this library and follow the instructions below. Our backend systems also use this library to validate Archfiles so if it passes here, it'll pass when you create your application.

$ gem install viaduct-archfile
$ vdt-archfile-check path/to/Archfile