Skip to main content
Kodexa platform components (assistants, stores, extension packs, etc.) can be managed using the CLI. This page explains how to list, view, and manage these components.

​
Listing Components

The get command allows you to list instances of a specific component type: 
kodexa get <object_type> [<ref>]
For example, to list all assistants: 
kodexa get assistants

​
Available Object Types

Some common object types include:
  • extensionPacks - Extension packages for the platform
  • assistants - AI assistants
  • stores - Stores (document, data, model)
  • organizations - Organizations
  • documentFamily - Document family collections
  • projects - Kodexa projects
To see all available object types: 
kodexa get

​
Filtering Results

You can filter results using a query: 
kodexa get assistants --query "name:*document*"
Or use filters for more complex queries: 
kodexa get assistants --filter --query "created>2023-01-01"

​
Pagination

For large result sets, use pagination: 
kodexa get stores --page 2 --pageSize 20

​
Formatting Output

You can format the output as JSON or YAML: 
kodexa get assistants --format json

​
Saving Results

Save results to a file: 
kodexa get stores --output-file stores.json

​
Viewing Component Details

To view details of a specific component, provide its reference: 
kodexa get assistants assistant-name/assistant-id

​
Deleting Components

To delete a component: 
kodexa delete component-type/component-id
For example: 
kodexa delete store/document-store-id
You’ll be prompted to confirm the deletion.

​
Platform Information

To view information about the current platform: 
kodexa platform

​
Examples

​
List all document stores

kodexa get stores --query "store_type:DOCUMENT"

​
Get details of a specific assistant

kodexa get assistants my-organization/my-assistant

​
List stores in a specific organization

kodexa get stores org-slug

​
List all components with JSON output

kodexa get assistants --format json

​
Stream all results without pagination

kodexa get documentFamily --stream

​
Search for components by name

kodexa get assistants --query "name:*extraction*"

​
Delete a component

kodexa delete store/my-document-store