JSON Mode

All Walrus client commands are available in JSON mode, which simplifies programmatic access to the CLI. You can specify all command-line flags of the original CLI command in JSON format.

To store a blob, run the following command:

$ walrus json \
    '{
        "config": "path/to/client_config.yaml",
        "command": {
            "store": {
                "files": ["README.md", "LICENSE"],
                "epochs": 100
            }
        }
    }'

To read a blob using the blob ID:

$ walrus json \
    '{
        "config": "path/to/client_config.yaml",
        "command": {
            "read": {
                "blobId": "4BKcDC0Ih5RJ8R0tFMz3MZVNZV8b2goT6_JiEEwNHQo"
            }
        }
    }'

All options, default values, and commands are the same as those in the standard CLI mode, except that they use camelCase instead of kebab-case.

The json command also accepts input from stdin.

The output of a json command is JSON-formatted to simplify parsing results programmatically. You can pipe the JSON output to the jq command to parse and extract relevant fields.