# README
Documentation for the Cadence command line interface is located at our main site.
Build CLI binary locally
To build the CLI tool locally check out the version tag (e.g. git checkout v0.21.3) and run make tools.
This produces an executable called cadence.
Run help command with a local build:
./cadence --help
Command to describe a domain would look like this:
./cadence --domain samples-domain domain describe
# Packages
No description provided by the author
# Functions
AdminAddSearchAttribute to whitelist search attribute.
AdminCatIndices cat indices for ES cluster.
AdminCloseShard closes shard by shard id.
AdminCountDLQMessages returns info how many and where DLQ messages are queued.
AdminDBClean is the command to clean up unhealthy executions.
AdminDBDataDecodeThrift is the command to decode thrift binary into JSON.
AdminDBScan is used to scan over executions in database and detect corruptions.
AdminDBScanUnsupportedWorkflow is to scan DB for unsupported workflow for a new release.
AdminDelete used to delete documents from ElasticSearch with input of list result.
AdminDeleteWorkflow delete a workflow execution for admin.
AdminDescribeCluster is used to dump information about the cluster.
AdminDescribeHistoryHost describes history host.
AdminDescribeQueue describes task processing queue states.
AdminDescribeShard describes shard by shard id.
AdminDescribeShardDistribution describes shard distribution.
AdminDescribeTaskList displays poller and status information of task list.
AdminDescribeWorkflow describe a new workflow execution for admin.
AdminFailoverAbort abort a failover workflow.
AdminFailoverList list failover runs.
AdminFailoverPause pause failover workflow.
AdminFailoverQuery query a failover workflow.
AdminFailoverResume resume a paused failover workflow.
AdminFailoverRollback rollback a failover run.
AdminFailoverStart start failover workflow.
No description provided by the author
AdminGetDLQMessages gets DLQ metadata.
AdminGetDomainIDOrName map domain.
No description provided by the author
AdminGetDynamicConfig gets value of specified dynamic config parameter matching specified filter.
No description provided by the author
AdminGetShardID get shardID.
AdminIndex used to bulk insert message from kafka parse.
AdminKafkaParse parses the output of k8read and outputs replication tasks.
AdminListConfigKeys lists all available dynamic config keys with description and default value.
AdminListDynamicConfig lists all values associated with specified dynamic config parameter or all values for all dc parameter if none is specified.
AdminListTaskList displays all task lists under a domain.
AdminMaintainCorruptWorkflow deletes workflow from DB if it's corrupt.
AdminMergeDLQMessages merges message from DLQ.
AdminPurgeDLQMessages deletes messages from DLQ.
No description provided by the author
No description provided by the author
AdminRefreshWorkflowTasks refreshes all the tasks of a workflow.
AdminRemoveTask describes history host.
AdminRereplicate parses will re-publish replication tasks to topic.
AdminResetQueue resets task processing queue states.
AdminRestoreDynamicConfig removes values of specified dynamic config parameter matching specified filter.
AdminSetShardRangeID set shard rangeID by shard id.
AdminShowWorkflow shows history.
AdminTimers is used to list scheduled timers.
No description provided by the author
No description provided by the author
AdminUpdateDynamicConfig updates specified dynamic config parameter with specified values.
No description provided by the author
No description provided by the author
CancelWorkflow cancels a workflow execution.
ColorEvent takes an event and return string with color Event with color mapping rules:
Failed - red Timeout - yellow Canceled - magenta Completed - green Started - blue Others - default (white/black).
CompleteActivity completes an activity.
CountWorkflow count number of workflows.
DescribeBatchJob describe the status of the batch job.
DescribeTaskList show pollers info of a given tasklist.
DescribeWorkflow show information about the specified workflow execution.
DescribeWorkflowWithID show information about the specified workflow execution.
DiagnoseWorkflow diagnoses a workflow execution.
No description provided by the author
FailActivity fails an activity.
GenerateReport generate report for an aggregation query to ES.
GetHistory helper method to iterate over all pages and return complete list of history events.
GetSearchAttributes get valid search attributes.
GetWorkflowHistoryIterator returns a HistoryEvent iterator.
HistoryEventToString convert HistoryEvent to string.
ListAllWorkflow list all workflow executions based on filters.
ListArchivedWorkflow lists archived workflow executions based on filters.
ListBatchJobs list the started batch jobs.
ListTaskListPartitions gets all the tasklist partition and host information.
ListWorkflow list workflow executions based on filters.
NewCliApp instantiates a new instance of the CLI application.
NewClientFactory creates a new ClientFactory.
NewDBLoadCloser creates a new LoadCloser to load timer task information from database.
Export a function to create an instance of the domainMigrationCLIImpl.
No description provided by the author
NewHistogram creates a new Histogram.
NewHistogramPrinter creates a new Printer to display timer task information in a histogram.
NewJSONPrinter creates a new Printer to display timer task information in a JSON format.
NewMockClientFactory creates a new mock instance.
NewMockLoadCloser creates a new mock instance.
NewMockManagerFactory creates a new mock instance.
NewMockPrinter creates a new mock instance.
NewReporter creates a new Reporter.
ObserveHistory show the process of running workflow.
ObserveHistoryWithID show the process of running workflow.
QueryWorkflow query workflow execution.
QueryWorkflowUsingQueryTypes list all query types of the workflow using __query_types as query type.
QueryWorkflowUsingStackTrace query workflow execution using __stack_trace as query type.
Render is an entry point for presentation layer.
RenderTable is generic function for rendering a slice of structs as a table.
RenderTemplate uses golang text/template format to render data with user provided template.
ResetInBatch resets workflow in batch.
ResetWorkflow reset workflow.
RestartWorkflow restarts a workflow execution.
RunWorkflow starts a new workflow execution and print workflow progress and result.
ScanAllWorkflow list all workflow executions using Scan API.
SetRequiredDomainDataKeys will set requiredDomainDataKeys.
ShowHistory shows the history of given workflow execution based on workflowID and runID.
ShowHistoryWithWID shows the history of given workflow with workflow_id.
SignalWithStartWorkflowExecution starts a workflow execution if not already exists and signals it.
SignalWorkflow signals a workflow execution.
StartBatchJob starts a batch job.
StartWorkflow starts a new workflow execution.
TerminateBatchJob stops abatch job.
TerminateWorkflow terminates a workflow execution.
WithIOHandler sets the IOHandler for the CLI app.
WithManagerFactory sets the ManagerFactory for the CLI app.
# Constants
CtxKeyJWT is the name of the context key for the JWT.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
typo, replaced by FlagParallelism.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Deprecated: use --format json.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
Flags used to specify cli command line arguments.
# Structs
No description provided by the author
No description provided by the author
ClustersConfig describes the kafka clusters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Histogram holds the occurrence count for each key.
No description provided by the author
JSONHistorySerializer is used to encode history event in JSON.
No description provided by the author
MockClientFactory is a mock of ClientFactory interface.
MockClientFactoryMockRecorder is the mock recorder for MockClientFactory.
MockLoadCloser is a mock of LoadCloser interface.
MockLoadCloserMockRecorder is the mock recorder for MockLoadCloser.
MockManagerFactory is a mock of ManagerFactory interface.
MockManagerFactoryMockRecorder is the mock recorder for MockManagerFactory.
MockPrinter is a mock of Printer interface.
MockPrinterMockRecorder is the mock recorder for MockPrinter.
RenderOptions allows passing optional flags for altering rendered table.
Reporter wraps LoadCloser, Printer and a filter on time task type and domainID.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WorkflowRow is a presentation layer entity use to render a table of workflows.
# Interfaces
ClientFactory is used to construct rpc clients.
No description provided by the author
No description provided by the author
LoadCloser loads timer task information.
No description provided by the author
Printer prints timer task information.
# Type aliases
No description provided by the author
ContextKey is an alias for string, used as context key.
No description provided by the author