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

​
--log-level
string
default:"INFO"
Set the logging level. Choices: DEBUG, INFO, WARNING, ERROR, CRITICAL.
​
--human-readable
boolean
default:"True"
Use human-readable log format.
​
--log-file
string
default:"cyyrus.log"
Name of the log file.
​
--log-dir
string
Directory to store log files.
​
--schema-path
string
required
Path to the schema file.
​
--env-path
string
Path to the optional environment file.
​
--export-format
string
Format to export the dataset.
​
--export-path
string
Directory to export the dataset.
​
--huggingface-token
string
Hugging Face token for authentication.
​
--repo-id
string
Hugging Face repo ID for dataset upload.

​
Usage

cyyrus run --schema-path /path/to/schema.yaml [OPTIONS]

​
Examples

  1. Basic usage with default options: 
    cyyrus run --schema-path ./schema.yaml
  2. Changing log level and log file: 
    cyyrus run --schema-path ./schema.yaml --log-level DEBUG --log-file debug.log
  3. Exporting data to a specific format and location: 
    cyyrus run --schema-path ./schema.yaml --export-format json --export-path ./output
  4. 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.
In development now. We’d love to hear if this is important to you.

​
cyyrus validate

Validate an existing schema file for correctness.
In development now. We’d love to hear if this is important to you.