Command line

Every option of the two commands that come with cosmos-syndex. Contributing data explains when to use each.

syndex-check

Check a file against what the Synthesizer data catalogue requires, before submitting it.

usage: syndex-check [-h] [--json] [--classify-only] paths [paths ...]

Positional Arguments

paths

Files to check.

Named Arguments

--json

Write the reports as JSON, for a machine to read.

--classify-only

Say what each file is, without checking whether it can be published.

syndex-submit

Send a file to a submission already registered on the portal. The token is on that submission’s page.

usage: syndex-submit [-h] [--portal PORTAL] [--check] [--quiet] token path

Positional Arguments

token

the submission’s upload token

path

the file to send

Named Arguments

--portal

portal to send to (default: ‘https://synthesizer-project.org/syndex’)

--check

run the checker on the file before sending it, and stop if it fails

--quiet

no progress output