Skip to Content
DocsKeywordsKeywords & Reserved Words

Keywords & Reserved Words

LODE has a small set of reserved words and constants used in schemas and the Vein binary format.

Schema Keywords

These are literal values that must appear in a .lode schema file:

KeywordContextValueDescription
schemaTop-level property"lode"Schema discriminator. Must be the literal string "lode".
versionTop-level propertynumber ≥ 1Schema major version.
nameTop-level propertystringHuman-readable structure name.
fieldsTop-level propertyarrayOrdered list of field definitions.
idField property1–255Numeric binary key.
typeField propertyType stringWire type identifier.
requiredField propertybooleanWhether the field must be present. Defaults to true.

Type Keywords

These are the valid values for a field’s type property:

KeywordDescription
stringUTF-8 encoded text
boolBoolean value (true / false)
string[]Array of UTF-8 strings
map<string,string>String-to-string key-value map

Reserved Type Keywords

The following type strings are reserved for future use and will cause a validation error if used:

ReservedIntended Use
int32-bit signed integer
uint32-bit unsigned integer
int6464-bit signed integer
float64-bit floating point
bytesRaw byte array
string[][]Nested string arrays
map<string,int>String-to-integer map

CLI Commands

CommandDescription
compileEncode JSON to Vein binary
decodeDecode Vein binary to JSON
fingerprintCompute SHA-256 hash
verifyCheck binary against hash
diffCompare two binaries

CLI Flags

FlagDescription
-sSchema file path
-oOutput file path
-h, --helpShow usage
Last updated on