cli.md

CLI Reference

The xsd2proto command-line tool provides an easy way to convert XSD files to Protocol Buffer definitions.

Usage

xsd2proto [options] <input.xsd>

Options

Flag	Long Form	Description	Default
-o	--output	Output file path	Input filename with .proto extension
-p	--package	Go package option for generated proto file	None
-v	--verbose	Enable verbose output	false
-h	--help	Show help message	-
	--version	Show version information	-
	--no-header	Disable auto-generation header comment	false
	--camel-case	Use camelCase for field names instead of snake_case	false
	--pascal-case	Use PascalCase for field names instead of snake_case	false

Examples

Basic Conversion

Convert an XSD file to a protobuf file with the same base name:

xsd2proto schema.xsd
# Output: schema.proto

Custom Output Path

Specify a custom output file path:

xsd2proto -o /path/to/output.proto schema.xsd

With Go Package Option

Generate protobuf with a specific Go package option:

xsd2proto -p "github.com/example/proto" schema.xsd

This will add the following option to the generated proto file:

option go_package = "github.com/example/proto";

Verbose Output

Enable detailed logging during conversion:

xsd2proto -v schema.xsd

Example verbose output:

Converting schema.xsd to protobuf...
Successfully parsed XSD schema with 3 elements, 5 complex types, 2 simple types
Successfully generated schema.proto

Header Comment Control

By default, generated proto files include a header comment indicating they were auto-generated:

To disable the header comment:

xsd2proto --no-header schema.xsd

Field Naming Styles

By default, field names are converted to snake_case (e.g., firstName → first_name). You can choose alternative naming styles:

CamelCase Field Names

xsd2proto --camel-case schema.xsd

This will use camelCase formatting (e.g., firstName → firstName, postalCode → postalCode).

PascalCase Field Names

xsd2proto --pascal-case schema.xsd

This will use PascalCase formatting (e.g., firstName → FirstName, postalCode → PostalCode).

Note: You cannot use both --camel-case and --pascal-case options simultaneously.