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:
| Keyword | Context | Value | Description |
|---|---|---|---|
schema | Top-level property | "lode" | Schema discriminator. Must be the literal string "lode". |
version | Top-level property | number ≥ 1 | Schema major version. |
name | Top-level property | string | Human-readable structure name. |
fields | Top-level property | array | Ordered list of field definitions. |
id | Field property | 1–255 | Numeric binary key. |
type | Field property | Type string | Wire type identifier. |
required | Field property | boolean | Whether the field must be present. Defaults to true. |
Type Keywords
These are the valid values for a field’s type property:
| Keyword | Description |
|---|---|
string | UTF-8 encoded text |
bool | Boolean 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:
| Reserved | Intended Use |
|---|---|
int | 32-bit signed integer |
uint | 32-bit unsigned integer |
int64 | 64-bit signed integer |
float | 64-bit floating point |
bytes | Raw byte array |
string[][] | Nested string arrays |
map<string,int> | String-to-integer map |
CLI Commands
| Command | Description |
|---|---|
compile | Encode JSON to Vein binary |
decode | Decode Vein binary to JSON |
fingerprint | Compute SHA-256 hash |
verify | Check binary against hash |
diff | Compare two binaries |
CLI Flags
| Flag | Description |
|---|---|
-s | Schema file path |
-o | Output file path |
-h, --help | Show usage |
Last updated on