NAME

prototext - Lossless protobuf ↔ enhanced-textproto converter

SYNOPSIS

prototext [--descriptor-set] [-o|--output] [-O|--output-root] [-I|--input-root] [-q|--quiet] [-h|--help] [-V|--version] <subcommands>

DESCRIPTION

Lossless protobuf ↔ enhanced-textproto converter

OPTIONS

--descriptor-set <DESCRIPTOR_SET_FILE>

FileDescriptorSet for type lookup and scoring.

The file may be a raw binary FileDescriptorSet, a #@ prototext-format FileDescriptorSet, or a single FileDescriptorProto. If a sibling <stem>/hopcroft.rkyv file exists it is loaded automatically and enables scoring and auto-inference.

Resolution order: (1) this flag, (2) PROTOTEXT_DESCRIPTOR_SET env var (PROTOTEXT_DEFAULT_DESCRIPTOR accepted with a deprecation warning), (3) built-in google.protobuf.* fallback.

-o, --output <PATH>

Write output to PATH (single input only; exclusive with --output-root)

-O, --output-root <DIR>

Write output files under DIR, mirroring the input tree (exclusive with --output and --in-place)

-I, --input-root <DIR>

Resolve positional paths and globs relative to DIR. Absolute positional paths are an error when set

-q, --quiet

Suppress warnings on stderr (errors are always printed)

-h, --help

Print help (see a summary with '-h')

-V, --version

Print version

SUBCOMMANDS

prototext-decode(1)

Decode binary protobuf to prototext

prototext-encode(1)

Encode prototext to binary protobuf

prototext-list-schemas(1)

Score input(s) against the DB and list candidate types, score-descending

prototext-score(1)

Score input(s) against a known schema type and report the match breakdown

prototext-help(1)

Print this message or the help of the given subcommand(s)

EXTRA

Examples:
# Decode to stdout (schemaless)
prototext decode foo.pb

# Decode with schema; annotations included by default
prototext --descriptor-set my.desc decode --type com.example.Foo foo.pb

# Suppress annotations (protoc-compatible output)
prototext --descriptor-set my.desc decode --type com.example.Foo \
--no-annotations foo.pb

# Identify the schema of an unknown binary
prototext --descriptor-set my.desc list-schemas foo.pb

# Encode prototext back to binary
prototext encode foo.txtpb -o foo.pb

VERSION

v0.2.0

ENVIRONMENT

PROTOTEXT_COMPLETE

When set to bash, zsh, or fish, print a shell completion script to stdout and exit. Used by the shell completion setup described below.

EXAMPLES

prototext decode message.binpb

prototext --descriptor-set descriptor.pb decode --type pkg.MyMessage message.binpb

prototext --descriptor-set descriptor.pb decode --type pkg.MyMessage message.binpb

prototext encode message.pb > message.binpb

protoc --encode=pkg.MyMessage descriptor.proto < input.txt | prototext --descriptor-set descriptor.pb decode --type pkg.MyMessage

source <(PROTOTEXT_COMPLETE=bash prototext)

SEE ALSO

protoc(1)