Skip to main content
2026-01-07

v8 Documentation Preview

Pre-release documentation for upcoming v8 CLI and SDK releases:CLI v8 - Document Commands (Preview):New kdx document command suite for working with local KDDB files without requiring a platform connection:
  • kdx document info - Display document summary with metadata and statistics
  • kdx document print - Pretty print document structure as an ASCII tree with depth limiting and feature display
  • kdx document select - Query nodes by type using selector syntax
  • kdx document natives list/extract - List and extract embedded files (PDFs, images, etc.)
  • kdx document external list/get/set/delete - Manage key-value external data store
  • kdx document metadata get/set - View and modify document metadata
# Quick document inspection
kdx document info invoice.kddb
kdx document print invoice.kddb --depth 3
kdx document select invoice.kddb "//paragraph"

# Extract embedded PDF
kdx document natives extract invoice.kddb original.pdf -o extracted.pdf
SDK Documentation Updates:
  • Native Documents: Store and retrieve binary files within KDDB documents
  • External Data: Flexible key-value store for custom data and processing results
  • Metadata: Document properties including UUID, version, and custom fields
  • Content Nodes: Hierarchical document structure with types and content
  • Selectors: XPath-like query syntax for finding nodes
Documentation Links:
These features are in preview and will be included in the upcoming v8 release of the KDX CLI and Kodexa Document SDKs.
2026-01-03

Kodexa Document SDK v8.0.0

New SDK Documentation & Version 8 Libraries:New Documentation:
  • SDK Documentation Tab: Added a dedicated SDK section to the developer portal with comprehensive guides for Python and TypeScript
  • Python Getting Started: Complete guide covering installation, document creation, node manipulation, selectors, features, tags, and saving
  • TypeScript Getting Started: Full guide including WASM initialization, async patterns, memory management, and browser/Node.js setup
Python SDK - kodexa-document v8.0.0:
  • High-performance document processing via Go backend with CFFI bindings
  • ~100x faster in-memory mode for processing pipelines
  • Full support for KDDB format, hierarchical nodes, features, tags, and XPath-like selectors
  • Context manager support for automatic resource cleanup
pip install kodexa-document
TypeScript SDK - @kodexa-ai/document-wasm-ts v8.0.0:
  • WebAssembly-powered SDK for Node.js and modern browsers
  • ~5x faster than pure JavaScript implementations
  • Full async API with TypeScript type safety
  • Works with both file-based and in-browser SQLite
npm install @kodexa-ai/document-wasm-ts
Key Features (Both SDKs):
  • Create, load, and save KDDB documents
  • Hierarchical ContentNode tree structure
  • XPath-like selector queries
  • Features (key-value metadata) and Tags (annotations with confidence)
  • JSON and binary export formats
Links:
2025-12-04

KDX CLI v0.5.2

Stability & User Experience Improvements:Bug Fixes:
  • Increased Client Timeout: Extended HTTP client timeout from 60 seconds to 10 minutes (600s) to prevent premature failures during long-running deployment operations, particularly beneficial for large manifest deployments, multiple resource/module deployments, and deployments to slow or distant environments
  • Improved Branch Mapping Error Handling: Changed behavior when no branch mapping is found - now displays informational message and exits gracefully instead of returning error, providing better UX when working on unmapped branches
Improvements:
  • Better CI/CD Integration: Non-disruptive behavior when working on unmapped branches doesn’t fail pipelines unnecessarily
  • Clearer User Feedback: Informational messages clearly distinguish between configuration issues and actual errors
  • Enhanced Reliability: Deployments that previously failed due to timeout will now complete successfully
Impact:
  • Prevents deployment timeouts for operations with large manifests or multiple resources
  • Better user experience when working with selective branch mapping configurations
  • More reliable long-running deployment operations
Breaking Changes: None - fully backward compatible with v0.5.0 and v0.5.1Download Links:Available in kdx-cli v0.5.2
2025-12-03

Kodexa Sync Action v2.2.0

Built-in Slack Notifications & GitHub Job Summary:New Features:
  • Slack Notifications: Send rich deployment summaries to Slack automatically with slack-channel-id and slack-token inputs
  • GitHub Job Summary: Add deployment summary to workflow run with annotate-summary: true
  • Renamed Input: workersthreads to match kdx-cli flag naming
Slack Message Includes:
  • 🚀 Deployment status (or 🔍 for dry runs)
  • Repository and branch information
  • Resource counts (created, updated, unchanged)
  • Direct link to the GitHub Actions run
Usage Example:
- uses: kodexa-ai/kdx-sync-action@v2
  with:
    threads: 8
    annotate-summary: true
    slack-channel-id: $\{{ secrets.SLACK_CHANNEL_ID }}
    slack-token: $\{{ secrets.SLACK_BOT_TOKEN }}
  env:
    KODEXA_PROD_API_KEY: $\{{ secrets.KODEXA_PROD_API_KEY }}
Available in kdx-sync-action v2.2.0
2025-12-03

KDX CLI v0.5.0

Tag-Based Deployments & Enhanced GitOps:Major Features:
  • Tag-Based Deployment Mappings: Deploy using git tags in addition to branches, enabling release-driven workflows with tag_mappings configuration supporting semantic versions, release candidates, and preview tags
  • Manual Deployment Overrides: New --branch and --tag flags provide explicit control over deployment routing without requiring git operations, perfect for CI/CD, testing, and rollback scenarios
  • JSON Deployment Reports: Generate structured JSON reports of deployment actions with --json-report <path> for CI/CD integration
  • Parallel Resource Deployment: New --threads <n> flag for configuring parallel threads during resource deployment - significantly faster for large deployments
  • Resource Filtering: Filter resources during deployment with --filter <pattern> for selective deployments
Improvements:
  • Enhanced Error Messages: Clear, actionable error messages with hints when mappings are not found
  • Better User Feedback: Deployment mode indicators showing whether using branch detection, tag detection, or manual override
  • Improved Mapping Resolution: Support for multiple overlapping mappings, enabling sophisticated multi-environment deployment strategies
Usage Examples:
# Deploy with JSON report
kdx sync deploy --json-report ./deploy-report.json

# Deploy with parallel threads (8)
kdx sync deploy --threads 8

# Deploy specific tag mapping
kdx sync deploy --tag v1.0.0

# Filter resources during deployment
kdx sync deploy --filter "invoice-*"
Configuration - Tag Mappings:
branch_mappings:
  - pattern: "main"
    target: production
    environment: prod

tag_mappings:
  - pattern: "v*"
    target: production
    environment: prod
  - pattern: "rc-*"
    target: staging
    environment: staging
Download Links:Available in kdx-cli v0.5.0
2025-12-02

KDX CLI v0.4.1

Enhanced Debugging, Error Handling & Sync Improvements:New Features:
  • Enhanced Client Debugging: Added detailed API request/response logging when debug mode is enabled, providing comprehensive information for troubleshooting
  • Improved Module Syncing: Updated module syncing to build and display full slugs with organization prefixes, improving clarity in logs and progress reporting
  • Enhanced Deployment Output: Deployment command now includes the environment URL in planned deployment messages, providing clearer context for users
  • Alternate Extension Support: Added support for both .yaml and .yml extensions when reading resource files, with improved error hints showing all attempted file paths
Improvements:
  • Better Error Messages: Error messages now reference full slugs with organization prefixes, making it easier to identify and debug issues
  • Improved Error Handling: Enhanced deployment error handling to capture and report errors without terminating the process immediately
  • Robust Payload Handling: New utility function to safely extract string values from interface types
  • Debug Mode Formatting: Conditionally display full response bodies based on debug mode for cleaner output in normal operation
Code Quality:
  • Fixed gofmt formatting in resource_types_test.go
Download Links:Available in kdx-cli v0.4.1
2025-11-27

KDX CLI v0.3.0

Knowledge Sets & Immutable Resources:New Features:
  • Knowledge Set Support: New knowledgeset resource type with full CRUD operations, including example configurations for financial knowledge sets and full support in metadata API and sync operations
  • Immutable Resource Types: Added support for immutable resources (featuretype and featureinstance) that cannot be modified once created, maintaining database integrity. Sync operations automatically skip updates for immutable resources with appropriate warnings
Download Links:Available in kdx-cli v0.3.0