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
Examples
-
Basic usage with default options:
-
Changing log level and log file:
-
Exporting data to a specific format and location:
-
Using an environment file and uploading to Hugging Face:
FAQ
How do I set up logging for Cyyrus?
How do I set up logging for Cyyrus?
Cyyrus provides flexible logging options. You can set the log level using the --log-level
option, choose between human-readable and machine-readable formats with --human-readable
, specify a log file name with --log-file
, and set a custom directory for log files using --log-dir
.
For example:
This command will run Cyyrus with DEBUG level logging, output to a file named cyyrus_debug.log
in the ./logs
directory.
How can I export my processed data?
How can I export my processed data?
Cyyrus allows you to export your processed data using the --export-format
and --export-path
options. The --export-format
option determines the format of your exported data, while --export-path
specifies where the exported data should be saved.
For instance:
This will process your data according to the schema and export it in CSV format to the ./exported_data
directory.
Can I upload my dataset directly to Hugging Face?
Can I upload my dataset directly to Hugging Face?
Yes, Cyyrus supports direct uploads to Hugging Face. To do this, you need to provide your Hugging Face token and the repository ID where you want to upload the dataset.
Use the --huggingface-token
option to provide your authentication token, and --repo-id
to specify the target repository.
For example:
This command will process your data and then upload it to the specified Hugging Face repository.
cyyrus init
Creates a new schema file with the specified name.
cyyrus validate
Validate an existing schema file for correctness.