Schema Reference

The Voltig schema is a tool that helps you build and manage your projects.

The Voltig schema defines the structure and options available for configuring your Voltig project. Below is a reference for each field:

Schema Fields

Below is a reference for each field in the Voltig schema:

Field	Type	Required	Description	Example
name	string	Yes	The name of your project.	my-project
version	string	No	The version of your project.	1.0.0
packages	array	Yes	List of packages to manage.	[node, python]
scripts	object	No	Custom scripts to run as commands.	{ build: '...' }
configPath	string	No	Path to additional config files.	./config/extra.yml

Custom Commands

You can define custom commands in the scripts section of your schema. Each key is the command name, and the value is the shell command to execute.

Command Name	Description	Example Command
build	Build your project	npm run build
test	Run tests	npm test
lint	Lint your codebase	eslint .

Example voltig.yml

packages:
  # Single package name (string)
  - name: "python3"
    version: latest
    manager: brew

  # Multiple package names (array)
  - name: ["node", "rust"]
    version: latest
    manager: brew

commands:
  build:
    summary: Build the project
    command: go build -o voltig .
  test:
    summary: Run tests
    command: go test ./...
  setup-dev:
    summary: Run setup script
    script: ./scripts/setup-dev.sh
  deploy:
    summary: Deploy with arguments
    script: ./scripts/deploy.sh
    args:
      - "--prod"