Change Log

​

Kodexa CLI v0.2.4

• Enhanced Apply Command: The kdx apply command now automatically detects module implementation configuration and uploads code in one step
• Streamlined Module Deployment: No separate deploy step needed - create/update metadata and upload implementation with a single kdx apply -f model.yml
• Improved Developer Experience: Clear progress indicators and detailed output during module deployment

• Removed kdx model deploy command: Use kdx apply -f <your-module.yml> instead for module deployment
• All existing module deployment workflows should be updated to use the new kdx apply command

• Corrected Error Messages: Fixed error message to reference the correct retry command (kdx apply -f <your-module.yml> instead of deprecated kdx model deploy)
• Code Formatting: Applied gofmt formatting across codebase for consistency

• Updated all cookiecutter templates (inference model, event model, transformer model) with new kdx apply workflow
• Added comprehensive module deployment section to resource operations guide
• Updated developer portal documentation to reflect simplified deployment process

• Faster module deployment workflow
• Reduced confusion with single command for all module operations
• Better alignment with Kubernetes-style declarative resource management

• macOS (Intel)
• macOS (Apple Silicon)
• Linux (x86_64)
• Linux (ARM64)
• Windows (x86_64)

​

Kodexa CLI v0.2.3

• Enhanced API Client: Improved resource handling capabilities for more robust API operations
• Resource Filtering: Better filtering and logging in API operations for improved visibility
• OpenAPI Loader: Disabled external reference resolution to prevent reference loading issues

• External Reference Resolution: Fixed issues with external reference resolution in OpenAPI loader that could cause loading failures

• More reliable API operations with enhanced resource handling
• Better debugging capabilities through improved logging
• Cleaner OpenAPI processing without external reference complications

• macOS (Intel)
• macOS (Apple Silicon)
• Linux (x86_64)
• Linux (ARM64)
• Windows (x86_64)

​

Kodexa CLI v0.2.2

• Enhanced Resource Filtering: Improved resource filtering capabilities in API operations for more precise resource discovery and management
• Better Logging: Enhanced logging throughout API operations for improved debugging and monitoring
• Resource Type Handling: Improved handling of resource types and schemes for more reliable operations

• Better visibility into API operations through enhanced logging
• More reliable resource filtering and discovery
• Improved debugging capabilities for troubleshooting

• macOS (Intel)
• macOS (Apple Silicon)
• Linux (x86_64)
• Linux (ARM64)
• Windows (x86_64)

​

Kodexa CLI v0.2.1

• Fixed Panic in Non-TTY Environments: Resolved critical nil pointer dereference that prevented kdx sync deploy from working in GitHub Actions and other non-interactive environments
• Added Nil Checks: Comprehensive nil pointer guards added to all progress display methods
• CI/CD Compatibility: Full support for automated deployments in all CI/CD platforms

• Enables kdx-sync-action@v2 to work reliably in GitHub Actions workflows
• Fixes deployment failures in Docker containers and automated pipelines
• Maintains backward compatibility with all existing functionality

• macOS (Intel)
• macOS (Apple Silicon)
• Linux (x86_64)
• Linux (ARM64)
• Windows (x86_64)

​

Kodexa CLI v0.1.20

• Branch-based Deployment: Automatic target and environment selection based on git branch mappings
• Flexible Deployment Options: Support for explicit target/env flags or automatic git-based deployment
• Deployment Validation: Comprehensive validation of targets, environments, and manifests before deployment
• Dry Run Support: Preview deployment changes without making actual modifications
• Confirmation Prompts: Optional confirmation for each target or all targets together
• Improved Error Messages: Enhanced error messages for missing configurations and failed deployments

• Enhanced Metadata Resolution: Improved metadata directory resolution with better error handling
• Configuration Validation: Enhanced validation of sync configuration files
• Resource Type Definitions: Updated resource type registry with comprehensive aliases
• Better Path Handling: Improved relative and absolute path resolution

• macOS (Intel)
• macOS (Apple Silicon)
• Linux (x86_64)
• Linux (ARM64)
• Windows (x86_64)

​

Kodexa CLI v0.1.18

• Intuitive Path Handling: Relative paths now resolve from the current working directory instead of the metadata directory, providing more predictable and user-friendly behavior
• Smart Slug Validation: Added warning logs for mismatches between configuration slugs and resource file slugs, with resource file slugs taking precedence
• Enhanced Documentation: Comprehensive usage examples added to clarify the new path handling behavior
• Improved Flexibility: Enhanced resource management with the new path resolution strategy applied across all related functions

​

Kodexa CLI v0.1.17

• Flexible File Operations: Added optional path override for resource file operations, allowing more flexible file handling in the CLI

​

Kodexa CLI v0.1.16

• Enhanced resource discovery and synchronization workflows
• Improved metadata handling and validation

​

Kodexa CLI v0.1.15

• Automatic Version Update Checking: Users are now automatically notified when a newer version is available
  • 24-hour caching to avoid excessive API calls
  • Clean, colorful notifications with OS-specific upgrade instructions
  • Supports macOS, Linux, and Windows (both ARM64 and AMD64)
• Comprehensive CI/CD Workflow: Added GitHub Actions workflows for automated quality assurance
  • Build verification and test execution with race detection
  • Code coverage reporting with automated PR comments
  • golangci-lint with 15+ linters including security checks
• Code Quality Improvements: Complete golangci-lint cleanup across the codebase
  • Updated for golangci-lint v1.60+ compatibility
  • Fixed 20+ unchecked errors and 10+ shadow variable declarations
  • Optimized struct field alignments and improved security
  • Applied consistent formatting across all files

​

Kodexa CLI v0.1.14

• New printWithMarkup function: Standardizes command output formatting with consistent markup rendering
• Updated sync package logging: Improved visual clarity and user experience
• Integrated markup in progress logging: Better presentation of synchronization messages

​

Kodexa CLI v0.1.13

• Production Environment Protection: Added confirmation prompts for critical operations in production environments
• Profile Production Flag: Profiles can now be marked as production with --production flag
• Automation Support: New --skip-production-confirm flag for CI/CD workflows
• Enhanced Profile Display: Profile listings now show production status
• Model → Module Terminology: Renamed all “model” references to “modules” for consistency
• Improved Client Profile Handling: Added Profile() and BaseURL() methods to Client
• Enhanced Synchronization Logging: Clearer status updates during metadata sync
• Streamlined Concurrency Handling: Centralized changeSequence field management

​

Kodexa CLI v0.1.12

• Improved metadata synchronization workflows
• Enhanced configuration validation
• Additional release automation improvements

​

Kodexa CLI v0.1.11

• Enhanced payload construction and error handling in resource synchronization
• Added configuration validation for sync operations
• Added Slack notification for release workflow

​

Kodexa CLI v0.1.10

• Enhanced organization slug handling in metadata synchronization
• Added resource retrieval and model creation enhancements
• Added resource retrieval and update methods in MetadataClient
• Improved model versioning support

​

Kodexa CLI v0.1.9

• Added comprehensive debug logging for model deployment path resolution
• Enhanced CLI output formatting and usage documentation
• Improved resource retrieval with filter support
• Enhanced deploy configuration handling and model metadata synchronization
• Added size and duration metrics for model implementation uploads
• Updated resource management and CLI documentation for improved clarity

​

Kodexa CLI v0.1.8

• Enhanced CLI output formatting and usage documentation for better developer experience

​

Kodexa CLI v0.1.7

• Added comprehensive debug logging for model deployment path resolution

​

Kodexa CLI v0.1.6

• Added dataclasses command to CLI for working with data classes
• Added prompt template resource type and enhanced metadata client
• Added prompt template support and enhanced model implementation handling
• Enhanced CLI resource retrieval with filter support

​

Kodexa CLI v0.1.5

• Added dataclasses command to CLI
• Added prompt template resource type and enhanced metadata client
• Added prompt template support and enhanced model implementation handling
• Enhanced resource discovery and synchronization with path prefix support
• Standardized resource type naming conventions

​

Pydantic Configuration Refactor

​

Knowledge Storage & Document Features

• Added knowledge storage capabilities to documents
• Expanded SDK features for enhanced document handling

​

New Models & Fields

• Added TaskTemplateAction and DocumentFamilyGroup models
• Added notes field to DocumentFamilyGroup model

​

Model Enhancements

• Added entry_points field to MessageTemplate model
• Added change_sequence and slug fields to Note model

​

Task Priority & Change Tracking

• Added priority field to Task model for task prioritization
• Added change_sequence field to Task model for change tracking

​

API Improvements

• Enhanced HTTP response code handling across endpoints
• Added platform overview API endpoint
• Improved logging in TasksEndpoint.create_with_template

​

Data Validation Improvements

• Implemented deduplication of DocumentTaxonValidation objects in SqliteDocumentPersistence
• Added overridable field to TaxonValidation model

​

Pagination & Cost Management

• Enhanced stream_query and filter methods with starting_offset parameter for improved pagination
• Added AggregatedModelCost class and ModelCostsEndpoint for model cost tracking

​

Notes Support

​

Model Refinements

• Renamed title to name in ProjectTaskTemplate for consistency
• Added slug field to TaskTemplate
• Enhanced datetime serialization format
• Expanded ProjectOptions model with new fields

​

Notes Models & Endpoints

• Introduced Note and PageNote models
• Added endpoints for notes functionality
• Added optional title field to Note model

​

Channel Enhancements

​

DataForm Options

​

Model Refactoring

• Refactored TaskDocumentFamily model to use IDs instead of full objects
• Enhanced TaxonValidation model with new fields for validation rules

​

Organization & Revision Support

• Added organization field to Session model
• Added ContentNode revisions and comments functionality

​

Project Template Types

​

Project Model Updates

• Added old_identifier field to Project models for migration support
• Added task_templates field to ProjectTemplate model

​

AI Token Support & Textract Enhancement

• Added support for thinking tokens and cached tokens in ModelInteraction
• Textract confidence scores now used when available

​

Data Management Enhancements

• Made tag field optional in DataAttribute model
• Added start and end date fields to ExecutionOverview model

​

Access to Data Exceptions

from kodexa import KodexaClient

client = KodexaClient()
data_exceptions = client.data_exceptions.list()

​

Adding Manifest handling to the CLI