Document Metadata with kdx CLI

# Get all metadata
kdx document metadata get <file.kddb>

# Get a specific key
kdx document metadata get <file.kddb> <key>

kdx document metadata get invoice.kddb

┌──────────┬─────────────────────────────────────────────────────┐
│  FIELD   │                       VALUE                         │
├──────────┼─────────────────────────────────────────────────────┤
│ uuid     │ e25dab60-cbdf-499f-857e-ff9c82a19d87                │
│ version  │ 6.0.0                                               │
│ labels   │ []                                                  │
│ source   │ {}                                                  │
│ metadata │ {"connector":"folder","source_path":"/docs/invoice"}│
└──────────┴─────────────────────────────────────────────────────┘

kdx document metadata get invoice.kddb source.connector

┌──────────────────┬────────┐
│      FIELD       │ VALUE  │
├──────────────────┼────────┤
│ source.connector │ folder │
└──────────────────┴────────┘

kdx document metadata set <file.kddb> <key> <json-value>

# Set a string value
kdx document metadata set invoice.kddb custom_field '"my value"'

# Set a number
kdx document metadata set invoice.kddb priority '1'

# Set a boolean
kdx document metadata set invoice.kddb reviewed 'true'

# Set an object
kdx document metadata set invoice.kddb config '{"enabled": true, "threshold": 0.8}'

# Set an array
kdx document metadata set invoice.kddb tags '["invoice", "processed"]'

Set metadata key: custom_field

# JSON output
kdx document metadata get invoice.kddb -o json

# YAML output
kdx document metadata get invoice.kddb -o yaml

{
  "uuid": "e25dab60-cbdf-499f-857e-ff9c82a19d87",
  "version": "6.0.0",
  "labels": [],
  "source": {},
  "metadata": {
    "connector": "folder",
    "source_path": "/docs/invoice.pdf",
    "title": "Invoice #123"
  }
}

# Get UUID
kdx document metadata get invoice.kddb -o json | jq -r '.uuid'

# Add processing timestamp
kdx document metadata set invoice.kddb processed_at '"2024-01-15T10:30:00Z"'

# Add reviewer info
kdx document metadata set invoice.kddb reviewer '"john.doe@company.com"'

# Add a label to all documents
for kddb in *.kddb; do
  kdx document metadata set "$kddb" batch_id '"batch-2024-01"'
done

# Get document UUID for API calls
UUID=$(kdx document metadata get invoice.kddb -o json | jq -r '.uuid')
echo "Processing document: $UUID"

# Check document version
VERSION=$(kdx document metadata get invoice.kddb -o json | jq -r '.version')
if [[ "$VERSION" < "6.0.0" ]]; then
  echo "Warning: Old document format"
fi

# Export as JSON
kdx document metadata get invoice.kddb -o json > invoice_metadata.json

# Export as YAML
kdx document metadata get invoice.kddb -o yaml > invoice_metadata.yaml