CLI
There’s a new sheriff in town. And it’s called the CLI.
Cyyrus comes with a powerful CLI that lets you interact with the system from the comfort of your terminal. The CLI is your go-to tool for generating data, managing schemas, and publishing datasets. It’s like a sidekick, always there to lend a hand.
cyyrus run
Generate the dataset as per the schema and optionally export the data or upload it to Hugging Face.
Options
Set the logging level. Choices: DEBUG, INFO, WARNING, ERROR, CRITICAL.
Use human-readable log format.
Name of the log file.
Directory to store log files.
Path to the schema file.
Path to the optional environment file.
Format to export the dataset.
Directory to export the dataset.
Hugging Face token for authentication.
Hugging Face repo ID for dataset upload.
Usage
cyyrus run --schema-path /path/to/schema.yaml [OPTIONS]
Examples
-
Basic usage with default options:
cyyrus run --schema-path ./schema.yaml
-
Changing log level and log file:
cyyrus run --schema-path ./schema.yaml --log-level DEBUG --log-file debug.log
-
Exporting data to a specific format and location:
cyyrus run --schema-path ./schema.yaml --export-format json --export-path ./output
-
Using an environment file and uploading to Hugging Face:
cyyrus run --schema-path ./schema.yaml --env-path .env --huggingface-token YOUR_TOKEN --repo-id your-username/your-dataset
FAQ
cyyrus init
Creates a new schema file with the specified name.
cyyrus validate
Validate an existing schema file for correctness.