CLI

Clone a project

Clone a Project or its resources of one type from Cognigy to your local machine.

# Clone all Project resources
cognigy clone
# Clone only Flows
cognigy clone --type flows
# Clone Flows and Endpoints
cognigy clone --type flows endpoints

Supported resource types: agent (all Project resources), flows, endpoints, lexicons, aiAgents.

Restore a project

Upload a Project or its resources from your local machine to Cognigy.

# Restore all Project resources
cognigy restore
# Restore only Flows
cognigy restore --type flows

Supported resource types: agent (all Project resources), flows, endpoints, lexicons, aiAgents.

Pull and push resources

Download or upload a specific resource by name.

# Download a specific Flow by name
cognigy pull flows myFlow
# Upload a specific Flow by name
cognigy push flows myFlow

Supported resource types for:

pull — flows, lexicons, endpoints, extensions, locales, aiAgents.
push — flows, lexicons, endpoints, aiAgents.

Compare local and remote resources

Compare a local resource against its remote version.

# Compare a Flow at the resource level
cognigy diff flows myFlow
# Compare a Flow at the Node level
cognigy diff flows myFlow --mode node

Supported resource types: flows, lexicons, endpoints, aiAgents.

Train a flow

Trigger NLU model training for a Flow.

# Train a Flow with the default timeout
cognigy train flow myFlow
# Train a Flow with a custom timeout in milliseconds
cognigy train flow myFlow --timeout 30000

Create a snapshot or locale

Creates a Snapshot or Locale in the remote Project and imports the new resource to your local Project.

# Create a Snapshot with an optional description
cognigy create snapshot mySnapshot "Optional description"
# Create a Locale
cognigy create locale myLocale

Export and import multilingual flow texts

Export a content.csv file with the text fields from Nodes in the Flow across all Locales, or import updated localized content back into a Flow.

# Export Flow texts to content.csv
cognigy exportcsv flow myFlow
# Import updated localized content back into the Flow
cognigy importcsv flow myFlow

Localize a flow

Add or remove localization for multiple Intents and Nodes at once.

# Add localization for a Flow from a source locale
cognigy localize flow myFlow --localeName de-DE --sourceLocale en-US
# Remove localization for a Flow
cognigy localize flow myFlow --localeName de-DE --reverse

Translate a flow

Translate Flow content using a machine translation provider.

# Translate a Flow using DeepL
cognigy translate flow myFlow --localeName de-DE --fromLanguage en --toLanguage de --translator deepl --apiKey <key>

Supported translation providers: google, microsoft, deepl.

Execute a raw API command

Pass a JSON payload directly to the Cognigy REST API client.

# Run an API command with a JSON payload
cognigy execute <command> -d '{"key": "value"}'
# List all available API commands
cognigy execute --list

Use --list to print all available API commands.

Run playbooks

Schedule Playbook runs on Cognigy and poll for results. The output is written to ./playbookRunResults.json.

# Run all Playbooks in the project
cognigy run playbooks
# Run Playbooks from a specific file
cognigy run playbooks ./myPlaybooks.json

Exit codes: 0 — success, 1 — failure, 2 — timeout.

Manage AI agent knowledge

Create a Knowledge Store, extract content from source documents, and ingest .ctxt files into the store.

# Create a Knowledge Store
cognigy knowledge-ai create source myStore "My store" --projectId <id> --language en-US
# Extract content from a PDF into a .ctxt file
cognigy knowledge-ai extract pdf -i ./docs/manual.pdf -o ./output/manual.ctxt
# Ingest .ctxt files into the Knowledge Store
cognigy knowledge-ai ingest --knowledgeStoreId <id> --input ./output/

Supported extraction types: text, pdf, docx, csv, json, jsonl, epub, srt, md, cheerio, playwright, diffbot, other.

Platform reference

Resource reference

Developer reference

Voice reference

Examples

Limitations

More information

​Examples

​Limitations

​More information

Examples

Limitations

More information