Buf(1)

NAME

buf-convert - Convert a message between binary, text, or JSON

SYNOPSIS

buf convert [flags]

DESCRIPTION

Use an input proto to interpret a proto/json message and convert it to a different format.

Examples:

    $ buf convert <input> --type=<type> --from=<payload> --to=<output>

The can be a local .proto file, binary output of "buf build", bsr module or local buf module:

    $ buf convert example.proto --type=Foo.proto --from=payload.json --to=output.binpb

All of , "--from" and "to" accept formatting options:

    $ buf convert example.proto#format=binpb --type=buf.Foo --from=payload#format=json --to=out#format=json

Both and "--from" accept stdin redirecting:

    $ buf convert <(buf build -o -)#format=binpb --type=foo.Bar --from=<(echo "{\"one\":\"55\"}")#format=json

Redirect from stdin to --from:

    $ echo "{\"one\":\"55\"}" | buf convert buf.proto --type buf.Foo --from -#format=json

Redirect from stdin to :

    $ buf build -o - | buf convert -#format=binpb --type buf.Foo --from=payload.json

Use a module on the bsr:

    $ buf convert <buf.build/owner/repository> --type buf.Foo --from=payload.json

OPTIONS

--error-format="text"
    The format for build errors printed to stderr. Must be one of [text,json,msvs,junit,github-actions]

--from="-"
    The location of the payload to be converted. Supported formats are [binpb,json,txtpb]

-h, --help[=false]
    help for convert

--to="-"
    The output location of the conversion. Supported formats are [binpb,json,txtpb]

--type=""
    The full type name of the message within the input (e.g. acme.weather.v1.Units)

OPTIONS INHERITED FROM PARENT COMMANDS

--debug[=false]
    Turn on debug logging

--log-format="color"
    The log format [text,color,json]

--timeout=2m0s
    The duration until timing out, setting it to zero means no timeout

-v, --verbose[=false]
    Turn on verbose mode

SEE ALSO

buf(1)

HISTORY

2023-08-02 Auto generated by spf13/cobra