Docs/Getting started

Getting started

Projects and manifests

Create a contained project with an entry file, tests and local dependencies.

About 8 minVersion: 0.10.1

Create a project

init creates orvi.toml, src/main.orvi and a project .gitignore. It refuses to overwrite existing project files.

orviscript init my-tool
cd my-tool
orviscript run

The orvi.toml manifest

The entry path must be a relative .orvi file contained inside the project. Commands search the current directory and its parents for the manifest.

orvi.toml
1[project]2name = "my-tool"3version = "0.1.0"4entry = "src/main.orvi"

Commands understand the project

When no file is supplied, run and check use the manifest entry. test discovers test_ tasks across every project source file.

orviscript run
orviscript check
orviscript test
orviscript deps