CLI Reference

Global Options

• --format: Change the output format to one of csv, json, or text. Defaults to text for human-readable output.
• --tz: Force the timezone to use for all date and time values. Defaults to the local timezone ($TZ on Unix systems) and falls back to UTC if no default is configured.

Commands

ai-query	LLM query management commands
ai-shell	Enter LLM shell
api	Generic API tool
cd-appointment	Appointment related commands
cd-article	Article related commands
cd-calendly	Calendly commands
cd-challenge	Challenge management commands
cd-cobject	Custom Object related commands
cd-encounter	Encounter related commands
cd-orgcare	Organization Care Team management
cd-orgdoc	Organization document reference management
cd-orgpractitioner	Organization practitioner management
cd-todo	Todo entires related commands
ck-brk	Cronkite Databricks extract-to-S3 Command
ck-cdc	Cronkite Change Data Capture Command
ck-dbd	Cronkite Database Driven Loader Command
ck-dbm-database	Cronkite Dbm Database Command
ck-dbm-rollup	Cronkite Dbm Rollup Command
ck-dbt-project	Cronkite Dbt Project Command
ck-llm	Cronkite LLM Command
ck-loader	Cronkite Loader Command
configurator	Configurator commands
cr-announcer	Courier announcer commands
cr-channel	Courier channel commands
cr-device	Courier device commands
cr-email	Courier email management commands
cr-notif	Courier notification commands
cr-text	Courier text/sms commands
cr-voice	Courier voice commands
cwd	Working directory management
dr-campaign	Campaign commands
dr-contact	Drow contacts
ds-dashboard	Dashboard commands
ds-jobspec	Job Spec commands
ds-repo	Repository commands
ds-report	Report commands
ds-table	Job Spec Table commands
ds-widget	Widget commands
ds-widgetspec	Widget Spec commands
es-spec	Elastic search spec management
fm-instance	Form instance management
fm-spec	Form spec management
gm-log	Gemfire log commands
gm-task	Gemfire task commands
id-archive	Manage identity archive requests
id-code	Signup code management
id-email	Identity email template management
id-email-logs	Outgoing email logs
id-feature	Identity feature management
id-group	Identity group management
id-org	Identity organization management
id-registration	Registration Invite
id-sms	Identity sms template management
id-task	Identity task management
id-theme	Manage identity organization theme
id-user	Identity user management
it-device	Device debugger
it-ltemaps	Integrator LTE Maps commands
it-oauth	Integrator Oauth commands
it-shipment	Device shipment management
iv-instance	Interview instance management
iv-profile	Workflow profile management
j2	jinja2 template rendering
jb-test	Job tester commands
lc-entries	Lachesis time-series commands
lc-tca	Lachesis TCA management
login	Login command
logout	Logout command
pg-design	Design related commands
pg-interaction	Interaction-related commands
pg-realm	Realm management
pg-sim	Playground simulation related commands
pk-bundle	Package bundle manager
pw-instance	Pathway instance management
pw-spec	Pathway spec management
pw-step	Pathway step management
py-cerner	Pylon EHR Cerner commands
py-elation	Pylon EHR Elation commands
py-epic	Pylon EHR EPIC commands
py-jobexec	Job Executor Configuration commands
py-jobsecret	Job Secret commands
py-jobspec	Job Spec commands
py-module	Job Module commands
py-repo	Pylon repository management
py-s3-event	Pylon S3 event commands
py-setting	Pylon setting commands
py-sftp-remote	Pylon SFTP remote server management
py-sftp-user	Pylon SFTP user management
py-vcs	Pylon repository management
shell	Enter IPython REPL with brewmaster initialized
sw-banner	Banner commands
sw-company	Company Commands
sw-debugger	Debugger commands
sw-helpdoc	Help Docs commands
sw-landingpage	Landing Page
sw-logo	Private label logo commands
sw-patient	Patient commands
sw-provider	Provider commands
version	Show version information
wf-config	Workflow program config
wf-instance	Workflow instance management
wf-interaction	Workflow interaction management
wf-lnp	LNP management
wf-profile	Workflow profile management
wf-program	Workflow program
wf-type	Workflow-type management
whoami	Show current user information

---

ai-query

LLM query management commands
Sub commands: create

create

crm ai-query create
  prompt
  [--context]
  [--detail]
  [--session]

1. prompt
2. --context Optional.
3. --detail Optional.
4. --session Optional.
   Session ID for continuing a conversation.

---

ai-shell

Enter LLM shell

---

api

Generic API tool
Sub commands: delete, get, patch, post

delete

Make an authenticated HTTP DELETE request

crm api delete
  path
  [--params]

1. path
   URL path to request.
2. --params Optional.

get

Make an authenticated HTTP GET request

crm api get
  path
  [--params]

1. path
   URL path to request.
2. --params Optional.
   Query parameters.

patch

Make an authenticated HTTP PATCH request

crm api patch
  path
  [--data]
  [--json]

1. path
   URL path to request.
2. --data Optional.
   Raw data to send in the request body.
3. --json Optional.
   JSON data to send in the request body.

post

Make an authenticated HTTP POST request

crm api post
  path
  [--data]
  [--json]

1. path
   URL path to request.
2. --data Optional.
   Raw data to send in the request body.
3. --json Optional.
   JSON data to send in the request body.

---

cd-appointment

Appointment related commands
Sub commands: create-status, create-type, list-status, list-type, update-status

create-status

Create a new appointment status

crm cd-appointment create-status
  display
  [--definition]
  [--default]
  [--no-default]
  [--void]
  [--no-void]

1. display
2. --definition Optional.
3. --default Optional.
4. --no-default Optional.
5. --void Optional.
6. --no-void Optional.

create-type

Create a new appointment type

crm cd-appointment create-type
  display
  [--definition]

1. display
2. --definition Optional.

list-status

List appointment statuses

crm cd-appointment list-status
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, display, definition, void, default
   

   Valid values:  created-at, created-by, default, definition, display, id, modified-at, modified-by, void
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-type

List appointment types

crm cd-appointment list-type
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, display, definition
   

   Valid values:  created-at, created-by, definition, display, id, modified-at, modified-by
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update-status

Update an appointment status

crm cd-appointment update-status
  status
  [--definition]
  [--default]
  [--no-default]
  [--void]
  [--no-void]

1. status
2. --definition Optional.
3. --default Optional.
4. --no-default Optional.
5. --void Optional.
6. --no-void Optional.

---

cd-article

Article related commands
Sub commands: add-content-file, add-content-url, bulk-create, create, delete, delete-content, get, list, update

add-content-file

Add a new content in the form of a file to an article

crm cd-article add-content-file
  article_id
  file
  content_type

1. article_id
   Article to add content to.
2. file
   File to upload.
3. content_type
   content-type of the file to set.

add-content-url

Add a new content in the form of a URL to an article

crm cd-article add-content-url
  article_id
  url

1. article_id
   Article to add content to.
2. url
   URL to set as article content.

bulk-create

crm cd-article bulk-create
  config

1. config

create

Create a new article

crm cd-article create
  title
  [--description]
  [--name]

1. title
   Title of the article.
2. --description Optional.
   Description of the article.
3. --name Optional.
   Name of the article.

delete

Delete an article

crm cd-article delete
  article_id

1. article_id
   Article to delete.

delete-content

Delete a content from an article

crm cd-article delete-content
  content_id

1. content_id
   Content to delete.

get

Get an article

crm cd-article get
  article_id

1. article_id
   Article to get.

list

List articles

crm cd-article list
  [--fields]
  [--individual]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, title, locale, views, tags
   

   Valid values:  created-at, description, id, locale, name, organization-id, tags, title, url, version, views
   
2. --individual Optional.
   Only show articles that this individual can see.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

update

Update an article

crm cd-article update
  article_id
  [--locale]
  [--parent-id]

1. article_id
   Article to update.
2. --locale Optional.
   Set locale for the article.

   Valid values:  en_US, es_US
   
3. --parent-id Optional.
   Set parent article.

---

cd-calendly

Calendly commands
Sub commands: get-user, list-account, list-user

list-account

crm cd-calendly list-account
  [--count]
  [--offset]
  [--fields]

1. --count Optional.
   Number of items to return.

   Default:  50
   
2. --offset Optional.
   Paging offset.
3. --fields Optional.
   Default:  id, name, created-at
   

   Valid values:  created-at, id, name
   

list-user

crm cd-calendly list-user
  account_id
  [--count]
  [--offset]
  [--fields]

1. account_id
2. --count Optional.
   Number of items to return.

   Default:  50
   
3. --offset Optional.
   Paging offset.
4. --fields Optional.
   Default:  id, name, scheduling-url, created-at
   

   Valid values:  created-at, id, name, scheduling-url
   

get-user

crm cd-calendly get-user
  user_id

1. user_id

---

cd-challenge

Challenge management commands
Sub commands: create, delete, get, list

create

crm cd-challenge create
  name
  workflow
  [--description]
  [--groups]

1. name
2. workflow
3. --description Optional.
4. --groups Optional.

delete

crm cd-challenge delete
  challenge_id

1. challenge_id

get

crm cd-challenge get
  challenge_id

1. challenge_id

list

crm cd-challenge list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, workflow, private, count-participants
   

   Valid values:  auto-group-sync, count-group-members, count-groups, count-participants, created-at, created-by, created-by-name, description, id, modified-at, modified-by, modified-by-name, name, private, status, workflow
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

---

cd-cobject

Custom Object related commands
Sub commands: add-column, alter-column, alter-table, create-table, describe, drop-column, drop-table, select, show-tables

add-column

crm cd-cobject add-column
  table_name
  column
  type
  [--default]
  [--display-name]
  [--indexed]
  [--options]

1. table_name
2. column
3. type
   Valid values:  boolean, date, datetime, enum, float, integer, string
   
4. --default Optional.
5. --display-name Optional.
6. --indexed Optional.
7. --options Optional.

alter-column

crm cd-cobject alter-column
  table_name
  field
  [--default]
  [--display-name]
  [--options]
  [--required]
  [--optional]

1. table_name
2. field
3. --default Optional.
4. --display-name Optional.
5. --options Optional.
6. --required Optional.
7. --optional Optional.

alter-table

crm cd-cobject alter-table
  table_name
  [--display-name]

1. table_name
2. --display-name Optional.

create-table

crm cd-cobject create-table
  name

1. name

drop-table

crm cd-cobject drop-table
  table_name

1. table_name

describe

crm cd-cobject describe
  table_name
  [field]
  [--fields]

1. table_name
2. field Optional.
3. --fields Optional.
   Default:  name, display-name, type, default, indexed, required
   

   Valid values:  created-at, created-by, default, display-name, id, indexed, modified-at, modified-by, name, options, required, type
   

drop-column

crm cd-cobject drop-column
  table_name
  field

1. table_name
2. field

select

crm cd-cobject select
  table_name
  [--parent]

1. table_name
2. --parent Optional.

show-tables

crm cd-cobject show-tables
  [table_name]

1. table_name Optional.

---

cd-encounter

Encounter related commands
Sub commands: create, create-type, delete, delete-type, get, list, list-type

create-type

crm cd-encounter create-type
  display
  [--definition]

1. display
2. --definition Optional.

delete-type

crm cd-encounter delete-type
  type_id

1. type_id

get

crm cd-encounter get
  encounter_id

1. encounter_id

list

crm cd-encounter list
  [--fields]
  [--external-id]
  [--individual]
  [--status]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, individual-id, start-time, notes
   

   Valid values:  created-at, created-by, duration, end-time, external-id, id, individual-id, modified-at, modified-by, notes, start-time, status
   
2. --external-id Optional.
3. --individual Optional.
4. --status Optional.
5. --offset Optional.
   Paging offset.
6. --count Optional.
   Number of items to return.

   Default:  50
   

list-type

crm cd-encounter list-type
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, organization-id, display
   

   Valid values:  created-at, created-by, definition, display, id, modified-at, modified-by, organization-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

create

crm cd-encounter create
  definition
  display

1. definition
2. display

delete

crm cd-encounter delete
  spec_id

1. spec_id

---

cd-orgcare

Organization Care Team management
Sub commands: create, delete, get, list, update

create

crm cd-orgcare create
  group_id
  name
  [--external-id]

1. group_id
2. name
3. --external-id Optional.

delete

crm cd-orgcare delete
  _id

1. _id

get

crm cd-orgcare get
  _id

1. _id

list

crm cd-orgcare list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, created-at
   

   Valid values:  created-at, created-by, external-id, group-id, id, modified-at, modified-by, name
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm cd-orgcare update
  _id
  [--external-id]
  [--name]

1. _id
2. --external-id Optional.
3. --name Optional.

---

cd-orgdoc

Organization document reference management
Sub commands: create, delete, download, list, list-class

create

crm cd-orgdoc create
  individual_id
  class_id
  file
  [--content-type]
  [--description]
  [--external-id]
  [--filename]

1. individual_id
2. class_id
3. file
4. --content-type Optional.
5. --description Optional.
6. --external-id Optional.
7. --filename Optional.

delete

crm cd-orgdoc delete
  doc_id

1. doc_id

download

crm cd-orgdoc download
  doc_id
  file

1. doc_id
2. file

list

crm cd-orgdoc list
  [--fields]
  [--individual-id]

1. --fields Optional.
   Default:  id, created-at, individual-id, description
   

   Valid values:  class-description, class-id, content-type, created-at, description, external-id, filename, id, individual-id, modified-at, ready
   
2. --individual-id Optional.

list-class

crm cd-orgdoc list-class
  [--fields]

1. --fields Optional.
   Default:  id, code, description
   

   Valid values:  code, created-at, description, id, modified-at, organization-id
   

---

cd-orgpractitioner

Organization practitioner management
Sub commands: create, delete, get, list, update

create

crm cd-orgpractitioner create
  first_name
  last_name
  [--display-name]
  [--external-id]
  [--gender]
  [--qualification-code]
  [--user-id]

1. first_name
2. last_name
3. --display-name Optional.
4. --external-id Optional.
5. --gender Optional.
6. --qualification-code Optional.
7. --user-id Optional.

delete

crm cd-orgpractitioner delete
  _id

1. _id

get

crm cd-orgpractitioner get
  _id
  [--individuals]

1. _id
2. --individuals Optional.

list

crm cd-orgpractitioner list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, display-name, user
   

   Valid values:  created-at, created-by, display-name, external-id, first-name, gender, id, last-name, modified-at, modified-by, qualification-code, user
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm cd-orgpractitioner update
  _id
  [--display-name]
  [--external-id]
  [--first-name]
  [--gender]
  [--last-name]
  [--qualification-code]
  [--user-id]

1. _id
2. --display-name Optional.
3. --external-id Optional.
4. --first-name Optional.
5. --gender Optional.
6. --last-name Optional.
7. --qualification-code Optional.
8. --user-id Optional.

---

cd-todo

Todo entires related commands
Sub commands: create-tag, delete-tag, get-tag, list-tag

list-tag

crm cd-todo list-tag
  [--count]
  [--offset]
  [--fields]

1. --count Optional.
   Number of items to return.

   Default:  50
   
2. --offset Optional.
   Paging offset.
3. --fields Optional.
   Default:  id, name, created-at
   

   Valid values:  created-at, id, name
   

get-tag

crm cd-todo get-tag
  tag_id

1. tag_id

create-tag

crm cd-todo create-tag
  name

1. name

delete-tag

crm cd-todo delete-tag
  tag_id

1. tag_id

---

ck-brk

Cronkite Databricks extract-to-S3 Command
Sub commands: create-config, create-run, delete-config, get-config, get-run, list-config, update-config

create-config

crm ck-brk create-config
  dbd_loader
  [--daily]

1. dbd_loader
2. --daily Optional.

delete-config

crm ck-brk delete-config
  config_id

1. config_id

get-config

crm ck-brk get-config
  config_id

1. config_id

list-config

crm ck-brk list-config
  [--offset]
  [--count]
  [--fields]
  [--dbd-loader]
  [--daily]
  [--no-daily]
  [--schema]
  [--table]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  1000
   
3. --fields Optional.
   Default:  schema, table, daily, last-run-at
   

   Valid values:  created-at, daily, dbd-loader-id, id, last-modified-at, last-run-at, schema, table
   
4. --dbd-loader Optional.
5. --daily Optional.
6. --no-daily Optional.
7. --schema Optional.
8. --table Optional.

update-config

crm ck-brk update-config
  config_id
  [--daily]
  [--no-daily]

1. config_id
2. --daily Optional.
3. --no-daily Optional.

create-run

crm ck-brk create-run
  config_id

1. config_id

get-run

crm ck-brk get-run
  config_id
  [run_id]
  [--sync]
  [--offset]
  [--count]

1. config_id
2. run_id Optional.
3. --sync Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  10
   

---

ck-cdc

Cronkite Change Data Capture Command
Sub commands: consumer-tick, create-config, delete-config, get-config, list-config, update-config

create-config

crm ck-cdc create-config
  dbd_loader
  [--consumer-group]
  [--primary-key]
  [--binlog]
  [--redshift]

1. dbd_loader
2. --consumer-group Optional.
3. --primary-key Optional.
4. --binlog Optional.
5. --redshift Optional.

delete-config

crm ck-cdc delete-config
  config_id

1. config_id

get-config

crm ck-cdc get-config
  config_id

1. config_id

list-config

crm ck-cdc list-config
  [--offset]
  [--count]
  [--fields]
  [--schema]
  [--table]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  1000
   
3. --fields Optional.
   Default:  schema, table, binlog-enabled, redshift-enabled
   

   Valid values:  binlog-enabled, consumer-group-id, created-at, dbd-loader-id, id, last-modified-at, primary-key, redshift-enabled, schema, table
   
4. --schema Optional.
5. --table Optional.

update-config

crm ck-cdc update-config
  config_id
  [--consumer-group]
  [--primary-key]
  [--binlog]
  [--no-binlog]
  [--redshift]
  [--no-redshift]

1. config_id
2. --consumer-group Optional.
3. --primary-key Optional.
4. --binlog Optional.
5. --no-binlog Optional.
6. --redshift Optional.
7. --no-redshift Optional.

consumer-tick

crm ck-cdc consumer-tick

---

ck-dbd

Cronkite Database Driven Loader Command
Sub commands: create, create-run, delete, gen, get, get-run, list, update, upsert

create

crm ck-dbd create
  args
  [--name]
  [--type]
  [--no-daily]

1. args
2. --name Optional.
3. --type Optional.
   Valid values:  basic_aurora, incremental_aurora, parallel_aurora
   
4. --no-daily Optional.
   Default:  True
   

delete

crm ck-dbd delete
  loader_id

1. loader_id

gen

crm ck-dbd gen
  name

1. name

get

crm ck-dbd get
  loader_id
  [--def]
  [--args]

1. loader_id
2. --def Optional.
3. --args Optional.

list

crm ck-dbd list
  [--offset]
  [--count]
  [--fields]
  [--name]
  [--daily]
  [--no-daily]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  1000
   
3. --fields Optional.
   Default:  name, last-run-at, schedule-daily
   

   Valid values:  id, last-run-at, name, schedule-daily, type
   
4. --name Optional.
5. --daily Optional.
6. --no-daily Optional.

update

crm ck-dbd update
  loader_id
  [--args]
  [--name]
  [--daily]
  [--no-daily]
  [--type]

1. loader_id
2. --args Optional.
3. --name Optional.
4. --daily Optional.
5. --no-daily Optional.
6. --type Optional.
   Valid values:  basic_aurora, incremental_aurora, parallel_aurora
   

upsert

crm ck-dbd upsert
  def

1. def

create-run

crm ck-dbd create-run
  loader_id
  [--no-wait]

1. loader_id
2. --no-wait Optional.
   Default:  True
   

get-run

crm ck-dbd get-run
  loader_id
  [run_id]
  [--offset]
  [--count]

1. loader_id
2. run_id Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  10
   

---

ck-dbm-database

Cronkite Dbm Database Command
Sub commands: list

list

crm ck-dbm-database list
  [--offset]
  [--count]
  [--fields]
  [--cluster]
  [--db-name]
  [--org]
  [--managed]
  [--no-managed]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   
3. --fields Optional.
   Default:  id, organization-id, db-name
   

   Valid values:  created-at, db-host, db-name, db-port, db-username, dbm-cluster-id, id, last-modified-at, managed, organization-id
   
4. --cluster Optional.
5. --db-name Optional.
6. --org Optional.
7. --managed Optional.
8. --no-managed Optional.

---

ck-dbm-rollup

Cronkite Dbm Rollup Command
Sub commands: list

list

crm ck-dbm-rollup list
  [--offset]
  [--count]
  [--fields]
  [--org]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  150
   
3. --fields Optional.
   Default:  organization-id, table-name, last-run-at
   

   Valid values:  created-at, dbm-database-id, id, last-run-at, organization-id, table-name
   
4. --org Optional.

---

ck-dbt-project

Cronkite Dbt Project Command
Sub commands: create, create-run, delete, delete-run, get, get-docs-info, get-run, list, list-run, update, upload

create

crm ck-dbt-project create
  name
  [--private-key]
  [--personal-access-token]
  [--schedule-daily]
  [--type]
  [--url]
  [--username]

1. name
2. --private-key Optional.
3. --personal-access-token Optional.
4. --schedule-daily Optional.
5. --type Optional.
   Valid values:  archive, git
   
6. --url Optional.
7. --username Optional.

delete

crm ck-dbt-project delete
  project_id

1. project_id

get

crm ck-dbt-project get
  project_id

1. project_id

get-docs-info

crm ck-dbt-project get-docs-info
  project_id
  [--target]

1. project_id
2. --target Optional.

list

crm ck-dbt-project list
  [--offset]
  [--count]
  [--fields]
  [--name]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   
3. --fields Optional.
   Default:  id, name, type, schedule-daily, url
   

   Valid values:  created-at, created-by, id, last-modified-at, last-modified-by, name, personal-access-token, private-key, schedule-daily, type, url, username
   
4. --name Optional.

upload

crm ck-dbt-project upload
  project_id
  project-path

1. project_id
2. project-path

update

crm ck-dbt-project update
  project_id
  [--name]
  [--no-schedule-daily]
  [--personal-access-token]
  [--private-key]
  [--schedule-daily]
  [--url]
  [--username]

1. project_id
2. --name Optional.
3. --no-schedule-daily Optional.
4. --personal-access-token Optional.
5. --private-key Optional.
6. --schedule-daily Optional.
7. --url Optional.
8. --username Optional.

create-run

crm ck-dbt-project create-run
  project_id
  [--branch]
  [--no-wait]
  [--select]
  [--target]
  [--upload-project-path]

1. project_id
2. --branch Optional.
3. --no-wait Optional.
4. --select Optional.
5. --target Optional.
6. --upload-project-path Optional.

delete-run

crm ck-dbt-project delete-run
  run_id

1. run_id

get-run

crm ck-dbt-project get-run
  run_id
  [--stdout]
  [--stderr]

1. run_id
2. --stdout Optional.
3. --stderr Optional.

list-run

crm ck-dbt-project list-run
  project_id
  [--offset]
  [--count]
  [--fields]

1. project_id
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   
4. --fields Optional.
   Default:  id, created-at, last-modified-at, status, target, schema
   

   Valid values:  branch, created-at, created-by, id, last-modified-at, project-id, schema, select, status, stderr, stdout, target
   

---

ck-llm

Cronkite LLM Command
Sub commands: create-individual, get-individual, get-sql, get-vector, list-individual, list-vector, sql

create-individual

crm ck-llm create-individual
  individual_id
  question
  [--model]
  [--vector-limit]
  [--vector-chunk]
  [--vector-context]

1. individual_id
2. question
3. --model Optional.
   Valid values:  titan-express, claude-3-sonnet
   
4. --vector-limit Optional.
5. --vector-chunk Optional.
6. --vector-context Optional.

get-individual

crm ck-llm get-individual
  run_id

1. run_id

get-sql

crm ck-llm get-sql
  query_id

1. query_id

get-vector

crm ck-llm get-vector
  entry_id

1. entry_id

list-individual

crm ck-llm list-individual
  individual_id
  [--fields]

1. individual_id
2. --fields Optional.
   Default:  id, created-at, question, token-input, token-output
   

   Valid values:  created-at, id, model, modified-at, question, state, token-input, token-output
   

list-vector

crm ck-llm list-vector
  individual_id
  query
  [--fields]
  [--count]

1. individual_id
2. query
3. --fields Optional.
   Default:  id, context-id, context-type
   

   Valid values:  context-id, context-type, created-at, id, modified-at
   
4. --count Optional.
   Number of items to return.

   Default:  30
   

sql

crm ck-llm sql
  query

1. query

---

ck-loader

Cronkite Loader Command
Sub commands: list

list

crm ck-loader list
  [--offset]
  [--count]
  [--fields]
  [--name]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   
3. --fields Optional.
   Default:  name, last-run-at
   

   Valid values:  created-at, id, last-run-at, loader-cls, name
   
4. --name Optional.

---

configurator

Configurator commands
Sub commands: reset, run

reset

crm configurator reset
  user_id

1. user_id

run

crm configurator run
  user_id
  template
  args

1. user_id
2. template
3. args

---

cr-announcer

Courier announcer commands
Sub commands: get, list

get

crm cr-announcer get
  announcer_id

1. announcer_id

list

crm cr-announcer list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, event, type
   

   Valid values:  args, created-at, created-by, event, id, modified-at, modified-by, name, type
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

---

cr-channel

Courier channel commands
Sub commands: archive, get, list, unarchive, update

get

crm cr-channel get
  channel_id
  [--individual-id]

1. channel_id
2. --individual-id Optional.

list

crm cr-channel list
  [--fields]
  [--individual]
  [--participant]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, subscriber, type, archived, label
   

   Valid values:  archived, created-at, created-by, group-id, group-name, group-provider-ack, id, label, msg-count, owner-id, owner-name, subscriber, type
   
2. --individual Optional.
3. --participant Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm cr-channel update
  channel_id
  [--group]
  [--group-provider-ack]
  [--no-group-provider-ack]
  [--label]
  [--name]

1. channel_id
2. --group Optional.
3. --group-provider-ack Optional.
4. --no-group-provider-ack Optional.
5. --label Optional.
6. --name Optional.

archive

crm cr-channel archive
  channel_id

1. channel_id

unarchive

crm cr-channel unarchive
  channel_id

1. channel_id

---

cr-device

Courier device commands
Sub commands: list

list

crm cr-device list
  [--all-users]
  [--app-name]
  [--app-version]
  [--fields]
  [--model]
  [--individual]
  [--shared-with]
  [--type]
  [--offset]
  [--count]

1. --all-users Optional.
2. --app-name Optional.
3. --app-version Optional.
4. --fields Optional.
   Default:  id, individual, type, app-version
   

   Valid values:  app-name, app-version, created-at, email, first-name, id, individual, last-login-time, last-modified-at, last-name, model, os-version, topic, type, user-id
   
5. --model Optional.
6. --individual Optional.
7. --shared-with Optional.
8. --type Optional.
   Valid values:  apn, fcm, web
   
9. --offset Optional.
   Paging offset.
10. --count Optional.
    Number of items to return.

    Default:  50
    

---

cr-email

Courier email management commands
Sub commands: create, get, list, update

create

crm cr-email create
  address
  [--unsubscribed]

1. address
2. --unsubscribed Optional.

get

crm cr-email get
  address

1. address

list

crm cr-email list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  address, modified-at, mode
   

   Valid values:  address, created-at, id, mode, modified-at
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm cr-email update
  address
  [--subscribe]
  [--unsubscribe]

1. address
2. --subscribe Optional.
3. --unsubscribe Optional.

---

cr-notif

Courier notification commands
Sub commands: bulk-multicast, clean, delete, get, list

bulk-multicast

crm cr-notif bulk-multicast
  individuals
  template_id
  template_data

1. individuals
2. template_id
3. template_data

clean

crm cr-notif clean
  [--individual]

1. --individual Optional.

delete

crm cr-notif delete
  notif_id

1. notif_id

get

crm cr-notif get
  notif_id

1. notif_id

list

crm cr-notif list
  [--individual]

1. --individual Optional.

---

cr-text

Courier text/sms commands
Sub commands: create, create-number, delete-number, get, list, list-number, list-send, log, send, update, update-number

create

crm cr-text create
  [--allow-custom-number]
  [--no-allow-custom-number]

1. --allow-custom-number Optional.
2. --no-allow-custom-number Optional.

create-number

crm cr-text create-number
  [--area-code]
  [--logging]
  [--notes]

1. --area-code Optional.
2. --logging Optional.
3. --notes Optional.

delete-number

crm cr-text delete-number
  phone_id

1. phone_id

get

crm cr-text get
  [--account]

1. --account Optional.

list

crm cr-text list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, organization-id, phone
   

   Valid values:  created-at, id, organization-id, phone, twilio-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-number

crm cr-text list-number
  [--phone-number]
  [--fields]

1. --phone-number Optional.
2. --fields Optional.
   Default:  id, phone-number, logging, flow, forward, notes
   

   Valid values:  account-id, cap-mms, cap-sms, cap-voice, created-at, flow, forward, id, lata, latitude, logging, longitude, notes, phone-number, rate-center, region, twilio-id, zipcode
   

list-send

crm cr-text list-send
  [--phone-id]
  [--target]
  [--fields]
  [--offset]
  [--count]

1. --phone-id Optional.
2. --target Optional.
3. --fields Optional.
   Default:  id, created-at, target, status
   

   Valid values:  created-at, created-by, error, from, id, message, modified-at, status, target
   
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm cr-text log
  phone_id
  [--fields]
  [--offset]
  [--count]

1. phone_id
2. --fields Optional.
   Default:  created-at, log
   

   Valid values:  created-at, log
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

send

crm cr-text send
  phone_id
  target
  message

1. phone_id
2. target
3. message

update

crm cr-text update
  account_id
  [--allow-custom-number]
  [--no-allow-custom-number]

1. account_id
2. --allow-custom-number Optional.
3. --no-allow-custom-number Optional.

update-number

crm cr-text update-number
  phone_id
  [--forward]
  [--logging]
  [--no-logging]
  [--notes]

1. phone_id
2. --forward Optional.
3. --logging Optional.
4. --no-logging Optional.
5. --notes Optional.

---

cr-voice

Courier voice commands
Sub commands: add-participant, create-activity, create-client-activity, create-conference, create-flow, create-pbe, create-queue, create-survey, create-survey-instance, create-user-outgoing-number, create-voice-mail-greeting, create-worker, create-worker-queue, create-workspace, delete-activity, delete-client-activity, delete-flow, delete-participant, delete-pbe, delete-queue, delete-user-outgoing-number, delete-voice-mail-greeting, delete-worker, delete-worker-queue, delete-workspace, get-activity, get-call, get-client-activity, get-conference, get-conference-file, get-conference-log, get-conference-summary, get-device, get-device-log, get-execution, get-flow, get-flow-log, get-mail, get-outgoing-number, get-queue, get-recording, get-reservation, get-survey, get-survey-instance, get-task, get-transcript, get-voice-mail-greeting, get-worker, get-worker-reservation, get-workspace, get-workspace-log, get-workspace-workflow, list-activity, list-client-activity, list-conference, list-conference-file, list-device, list-execution, list-flow, list-mail, list-outgoing-number, list-pbe, list-queue, list-recording, list-reservation, list-survey, list-survey-instance, list-task, list-user-outgoing-number, list-worker, list-workspace, list-workspace-workflow, set-default-flow, setup, show, update-activity, update-client-activity, update-device, update-flow, update-outgoing-number, update-participant, update-queue, update-survey, update-voice-mail-greeting, update-worker, update-workspace-workflow

add-participant

Add a participant to an active conference

crm cr-voice add-participant
  conference_id
  target
  [--cold]
  [--use-phone]

1. conference_id
2. target
3. --cold Optional.
4. --use-phone Optional.

create-conference

Start a new voice conference

crm cr-voice create-conference
  caller_id
  target
  [--digits]
  [--transcribe]

1. caller_id
2. target
3. --digits Optional.
4. --transcribe Optional.

create-activity

Create a workspace activity

crm cr-voice create-activity
  name
  workspace_id
  [--availability]

1. name
2. workspace_id
3. --availability Optional.
   Valid values:  true, false
   

create-flow

Create a voice flow

crm cr-voice create-flow
  name
  [--definition]
  [--sid]
  [--workspace]

1. name
2. --definition Optional.
3. --sid Optional.
4. --workspace Optional.

create-client-activity

Create a voice client activity

crm cr-voice create-client-activity
  name
  [--client-state]
  [--display-name]
  [--ui-order]
  [--ui-selectable]
  [--not-ui-selectable]

1. name
2. --client-state Optional.
   Default:  unavailable
   

   Valid values:  available, unavailable
   
3. --display-name Optional.
4. --ui-order Optional.
5. --ui-selectable Optional.
6. --not-ui-selectable Optional.

create-voice-mail-greeting

Create a voice-mail greeting for a user

crm cr-voice create-voice-mail-greeting
  user_id
  greeting

1. user_id
2. greeting

create-pbe

Create a voice phone book entry

crm cr-voice create-pbe
  [--description]
  [--extension]
  [--phone]
  [--preference]
  [--user]

1. --description Optional.
2. --extension Optional.
3. --phone Optional.
4. --preference Optional.
   Default:  device
   

   Valid values:  device, phone
   
5. --user Optional.

create-queue

Create a workspace queue

crm cr-voice create-queue
  workspace_id
  name
  [--assignment-activity-id]
  [--reservation-activity-id]
  [--target-worker-expression]

1. workspace_id
2. name
3. --assignment-activity-id Optional.
4. --reservation-activity-id Optional.
5. --target-worker-expression Optional.

create-survey

Create a voice survey

crm cr-voice create-survey
  name
  spec

1. name
2. spec

create-survey-instance

Create a survey instance for a participant

crm cr-voice create-survey-instance
  survey_id
  participant_id

1. survey_id
2. participant_id

create-user-outgoing-number

Create a user outgoing number mapping

crm cr-voice create-user-outgoing-number
  number
  user_id

1. number
2. user_id

create-worker

Create a workspace worker

crm cr-voice create-worker
  workspace_id
  user_id
  [--attributes]

1. workspace_id
2. user_id
3. --attributes Optional.

create-workspace

Create a voice workspace

crm cr-voice create-workspace
  name
  [--multitasking]

1. name
2. --multitasking Optional.

create-worker-queue

Assign a worker to a workspace queue

crm cr-voice create-worker-queue
  worker_id
  queue_id

1. worker_id
2. queue_id

delete-participant

Remove a participant from a conference

crm cr-voice delete-participant
  participant_id

1. participant_id

delete-activity

Delete a workspace activity

crm cr-voice delete-activity
  activity_id

1. activity_id

delete-flow

Delete a voice flow

crm cr-voice delete-flow
  flow_id

1. flow_id

delete-client-activity

Delete a voice client activity

crm cr-voice delete-client-activity
  client_activity_id

1. client_activity_id

delete-queue

Delete a workspace queue

crm cr-voice delete-queue
  queue_id

1. queue_id

delete-workspace

Delete a voice workspace

crm cr-voice delete-workspace
  workspace_id

1. workspace_id

delete-pbe

Delete a voice phone book entry

crm cr-voice delete-pbe
  pbe_id

1. pbe_id

delete-user-outgoing-number

Delete a user outgoing number mapping

crm cr-voice delete-user-outgoing-number
  user_outgoing_number_id

1. user_outgoing_number_id

delete-voice-mail-greeting

Delete a voice-mail greeting

crm cr-voice delete-voice-mail-greeting
  greeting_id

1. greeting_id

delete-worker

Delete a workspace worker

crm cr-voice delete-worker
  worker_id

1. worker_id

delete-worker-queue

Remove a worker from a workspace queue

crm cr-voice delete-worker-queue
  worker_id
  queue_id

1. worker_id
2. queue_id

get-activity

Retrieve workspace activity details

crm cr-voice get-activity
  activity_id

1. activity_id

get-call

Retrieve call details

crm cr-voice get-call
  call_id

1. call_id

get-conference

Retrieve conference details

crm cr-voice get-conference
  conference_id

1. conference_id

get-conference-summary

Retrieve AI summary for a conference

crm cr-voice get-conference-summary
  conference_id

1. conference_id

get-conference-file

Retrieve a conference file and optionally download it

crm cr-voice get-conference-file
  conference_file_id
  [--file]

1. conference_file_id
2. --file Optional.

get-conference-log

Retrieve or follow conference event logs

crm cr-voice get-conference-log
  conference_id
  [event_id]
  [-f/--follow]
  [--offset]
  [--count]

1. conference_id
2. event_id Optional.
3. -f/--follow Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  1000
   

get-device

Retrieve voice device details

crm cr-voice get-device
  device_id

1. device_id

get-device-log

Retrieve voice device client activity logs

crm cr-voice get-device-log
  device_id
  [log_id]

1. device_id
2. log_id Optional.

get-execution

Retrieve flow execution details

crm cr-voice get-execution
  execution_id

1. execution_id

get-flow

Retrieve voice flow details or definition

crm cr-voice get-flow
  flow_id
  [--associate]
  [--disassociate]
  [--definition]
  [--sync]

1. flow_id
2. --associate Optional.
3. --disassociate Optional.
4. --definition Optional.
5. --sync Optional.

get-client-activity

Retrieve voice client activity details

crm cr-voice get-client-activity
  client_activity_id

1. client_activity_id

get-flow-log

Retrieve voice flow log entries

crm cr-voice get-flow-log
  flow_id
  [log_id]
  [--execution]

1. flow_id
2. log_id Optional.
3. --execution Optional.

get-mail

Retrieve voicemail details and optionally download audio

crm cr-voice get-mail
  mail_id
  [--file]

1. mail_id
2. --file Optional.

get-voice-mail-greeting

Retrieve voice-mail greeting by greeting id or user selector

crm cr-voice get-voice-mail-greeting
  greeting_id

1. greeting_id

get-outgoing-number

Retrieve outgoing number details

crm cr-voice get-outgoing-number
  outgoing_number_id

1. outgoing_number_id

get-queue

Retrieve workspace queue details

crm cr-voice get-queue
  queue_id

1. queue_id

get-recording

Retrieve recording details and optionally download audio

crm cr-voice get-recording
  recording_id
  [--file]

1. recording_id
2. --file Optional.

get-survey

Retrieve voice survey details or spec

crm cr-voice get-survey
  survey_id
  [--spec]

1. survey_id
2. --spec Optional.

get-survey-instance

Retrieve survey instance details

crm cr-voice get-survey-instance
  instance_id

1. instance_id

get-task

Retrieve workspace task details

crm cr-voice get-task
  task_id
  [--close]
  [--sync]

1. task_id
2. --close Optional.
   Valid values:  canceled, completed
   
3. --sync Optional.

get-transcript

Retrieve transcript details

crm cr-voice get-transcript
  transcript_id

1. transcript_id

get-worker

Retrieve workspace worker details

crm cr-voice get-worker
  worker_id
  [--attributes]

1. worker_id
2. --attributes Optional.

get-worker-reservation

Retrieve worker reservations by worker selector or reservation id

crm cr-voice get-worker-reservation
  reservation_selector
  [--fields]
  [--offset]
  [--count]

1. reservation_selector
2. --fields Optional.
   Default:  id, modified-at, status, task, assignment
   

   Valid values:  assignment, created-at, id, modified-at, status, task, workspace
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

get-reservation

Retrieve workspace reservation details

crm cr-voice get-reservation
  reservation_id

1. reservation_id

get-workspace

Retrieve workspace details

crm cr-voice get-workspace
  workspace_id

1. workspace_id

get-workspace-log

Retrieve or follow workspace event logs

crm cr-voice get-workspace-log
  workspace_id
  [log_id]
  [--queue]
  [--worker]
  [--offset]
  [--count]

1. workspace_id
2. log_id Optional.
3. --queue Optional.
4. --worker Optional.
5. --offset Optional.
   Paging offset.
6. --count Optional.
   Number of items to return.

   Default:  20
   

get-workspace-workflow

Retrieve workspace workflow details

crm cr-voice get-workspace-workflow
  workflow_id
  [--config]

1. workflow_id
2. --config Optional.

list-conference

List voice conferences

crm cr-voice list-conference
  [--caller]
  [--fields]
  [--user]
  [--offset]
  [--count]

1. --caller Optional.
2. --fields Optional.
   Default:  id, modified-at, caller, target, type, state
   

   Valid values:  caller, created-at, id, modified-at, state, target, target-external-id, type
   
3. --user Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  20
   

list-client-activity

List voice client activities

crm cr-voice list-client-activity
  [--name]
  [--fields]
  [--offset]
  [--count]

1. --name Optional.
2. --fields Optional.
   Default:  id, last-modified-at, name, client-state
   

   Valid values:  client-state, created-at, created-by, display-name, id, last-modified-at, last-modified-by, name, setting, ui-order, ui-selectable
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-conference-file

List files attached to a conference

crm cr-voice list-conference-file
  conference_id
  [--fields]
  [--offset]
  [--count]

1. conference_id
2. --fields Optional.
   Default:  id, type, size, state
   

   Valid values:  conference-id, created-at, id, modified-at, size, state, type
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-activity

List workspace activities

crm cr-voice list-activity
  workspace_id
  [--fields]
  [--offset]
  [--count]

1. workspace_id
2. --fields Optional.
   Default:  id, name, availability
   

   Valid values:  availability, created-at, id, modified-at, name, twilio-sid
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-device

List voice devices

crm cr-voice list-device
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, user, state, last-active
   

   Valid values:  created-at, expires-at, id, last-active, modified-at, state, user, user-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  20
   

list-execution

List flow executions

crm cr-voice list-execution
  flow_id
  [--fields]
  [--offset]
  [--count]

1. flow_id
2. --fields Optional.
   Default:  id, modified-at, contact, status
   

   Valid values:  call, contact, created-at, id, modified-at, status
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-flow

List voice flows

crm cr-voice list-flow
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, modified-at, state
   

   Valid values:  created-at, id, modified-at, name, setting, sid, state
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  20
   

list-queue

List workspace queues

crm cr-voice list-queue
  workspace_id
  [--fields]
  [--offset]
  [--count]

1. workspace_id
2. --fields Optional.
   Default:  id, name, task-order
   

   Valid values:  created-at, id, modified-at, name, task-order, twilio-sid
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-mail

List voicemail messages

crm cr-voice list-mail
  [--fields]
  [--from]
  [--owner]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, modified-at, from, owner-id
   

   Valid values:  created-at, from, id, modified-at, owner-id, recording-id
   
2. --from Optional.
3. --owner Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  20
   

list-outgoing-number

List outgoing numbers

crm cr-voice list-outgoing-number
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, display-name, number
   

   Valid values:  display-name, id, name, number
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  20
   

list-user-outgoing-number

List user outgoing number mappings

crm cr-voice list-user-outgoing-number
  [--number]
  [--user]
  [--fields]
  [--offset]
  [--count]

1. --number Optional.
2. --user Optional.
3. --fields Optional.
   Default:  id, outgoing-number, user
   

   Valid values:  id, outgoing-number, user
   
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  20
   

list-pbe

List voice phone book entries

crm cr-voice list-pbe
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, user, extension, phone
   

   Valid values:  created-at, created-by, description, extension, id, modified-at, modified-by, phone, preference, user
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  20
   

list-recording

List voice recordings

crm cr-voice list-recording
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, modified-at, duration, state
   

   Valid values:  created-at, download-count, duration, id, modified-at, state
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  20
   

list-reservation

List workspace reservations

crm cr-voice list-reservation
  workspace_id
  [--fields]
  [--offset]
  [--count]

1. workspace_id
2. --fields Optional.
   Default:  id, modified-at, worker, task, status
   

   Valid values:  created-at, id, modified-at, status, task, worker, workspace
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-survey

List voice surveys

crm cr-voice list-survey
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, created-at, name, version
   

   Valid values:  created-at, id, modified-at, name, version
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  20
   

list-survey-instance

List instances for a voice survey

crm cr-voice list-survey-instance
  survey_id
  [--fields]
  [--offset]
  [--count]

1. survey_id
2. --fields Optional.
   Default:  id, created-at, participant
   

   Valid values:  call, created-at, created-by, id, modified-at, participant, state, version
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-task

List workspace tasks

crm cr-voice list-task
  workspace_id
  [--fields]
  [--offset]
  [--count]

1. workspace_id
2. --fields Optional.
   Default:  id, modified-at, age, assignment, queue
   

   Valid values:  age, assignment, created-at, id, modified-at, priority, queue, status, timeout, workspace
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-worker

List workspace workers

crm cr-voice list-worker
  workspace_id
  [--fields]
  [--offset]
  [--count]

1. workspace_id
2. --fields Optional.
   Default:  id, name, activity, auto-complete
   

   Valid values:  activity, auto-complete, id, name, twilio-sid
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

list-workspace

List voice workspaces

crm cr-voice list-workspace
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, modified-at
   

   Valid values:  created-at, id, modified-at, name, twilio-sid
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  20
   

list-workspace-workflow

List workspace workflows

crm cr-voice list-workspace-workflow
  workspace_id
  [--fields]
  [--offset]
  [--count]

1. workspace_id
2. --fields Optional.
   Default:  id, name, modified-at, default-task-queue
   

   Valid values:  created-at, default-task-queue, id, modified-at, name, task-reservation-timeout, twilio-sid
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  20
   

setup

Configure organization voice settings

crm cr-voice setup
  [--phone]

1. --phone Optional.

set-default-flow

Set default voice flow

crm cr-voice set-default-flow
  flow_id

1. flow_id

show

Display current voice configuration

crm cr-voice show

update-activity

Update a workspace activity

crm cr-voice update-activity
  activity_id
  [--name]

1. activity_id
2. --name Optional.

update-device

Update a voice device

crm cr-voice update-device
  device_id
  [--client-activity]
  [--client-state]

1. device_id
2. --client-activity Optional.
3. --client-state Optional.
   Valid values:  available, unavailable
   

update-flow

Update a voice flow definition or settings

crm cr-voice update-flow
  flow_id
  [--definition]
  [--name]
  [--publish]
  [--workspace]
  [--associate]
  [--disassociate]

1. flow_id
2. --definition Optional.
3. --name Optional.
4. --publish Optional.
5. --workspace Optional.
6. --associate Optional.
7. --disassociate Optional.

update-client-activity

Update a voice client activity

crm cr-voice update-client-activity
  client_activity_id
  [--client-state]
  [--display-name]
  [--name]
  [--ui-order]
  [--ui-selectable]
  [--not-ui-selectable]

1. client_activity_id
2. --client-state Optional.
   Valid values:  available, unavailable
   
3. --display-name Optional.
4. --name Optional.
5. --ui-order Optional.
6. --ui-selectable Optional.
7. --not-ui-selectable Optional.

update-voice-mail-greeting

Update a voice-mail greeting

crm cr-voice update-voice-mail-greeting
  greeting_id
  greeting

1. greeting_id
2. greeting

update-outgoing-number

Update outgoing number details

crm cr-voice update-outgoing-number
  number
  [--display-name]
  [--name]

1. number
2. --display-name Optional.
3. --name Optional.

update-participant

Update participant mute/hold state

crm cr-voice update-participant
  participant_id
  [--muted]
  [--unmuted]
  [--hold]
  [--unhold]

1. participant_id
2. --muted Optional.
3. --unmuted Optional.
4. --hold Optional.
5. --unhold Optional.

update-queue

Update a workspace queue

crm cr-voice update-queue
  queue_id
  [--assignment-activity-id]
  [--max-reserved-workers]
  [--name]
  [--reservation-activity-id]
  [--target-worker-expression]
  [--task-order]

1. queue_id
2. --assignment-activity-id Optional.
3. --max-reserved-workers Optional.
4. --name Optional.
5. --reservation-activity-id Optional.
6. --target-worker-expression Optional.
7. --task-order Optional.
   Valid values:  FIFO, LIFO
   

update-survey

Update a voice survey spec

crm cr-voice update-survey
  survey_id
  [--spec]

1. survey_id
2. --spec Optional.

update-worker

Update a workspace worker

crm cr-voice update-worker
  worker_id
  [--auto-complete]
  [--no-auto-complete]
  [--activity]
  [--attributes]
  [--order]

1. worker_id
2. --auto-complete Optional.
3. --no-auto-complete Optional.
4. --activity Optional.
5. --attributes Optional.
6. --order Optional.

update-workspace-workflow

Update workspace workflow configuration

crm cr-voice update-workspace-workflow
  workflow_id
  [--config]

1. workflow_id
2. --config Optional.

---

cwd

Working directory management
Sub commands: set, show

set

crm cwd set
  dir

1. dir

show

crm cwd show

---

dr-campaign

Campaign commands
Sub commands: add-attachment, add-contact, create, delete, delete-attachment, delete-contact, get, get-attachment, get-contact, list, list-attachment, list-contact, log, set-default, start, update, update-contact

add-attachment

crm dr-campaign add-attachment
  campaign_id
  file
  [--content-type]

1. campaign_id
2. file
3. --content-type Optional.

add-contact

crm dr-campaign add-contact
  campaign_id
  [--email]
  [--phone]

1. campaign_id
2. --email Optional.
3. --phone Optional.

create

crm dr-campaign create
  name
  subject
  template
  [--sms-template]

1. name
2. subject
3. template
4. --sms-template Optional.

delete

crm dr-campaign delete
  campaign_id

1. campaign_id

delete-attachment

crm dr-campaign delete-attachment
  attachment_id

1. attachment_id

delete-contact

crm dr-campaign delete-contact
  campaign_id
  email

1. campaign_id
2. email

get

crm dr-campaign get
  campaign_id
  [--template]

1. campaign_id
2. --template Optional.

get-attachment

crm dr-campaign get-attachment
  attachment_id
  outfile

1. attachment_id
2. outfile

get-contact

crm dr-campaign get-contact
  contact_id

1. contact_id

list

crm dr-campaign list
  [--fields]
  [--count]

1. --fields Optional.
   Default:  id, name, email-subject, modified-at
   

   Valid values:  created-at, created-by, data, display-name, email-from, email-subject, id, modified-at, modified-by, name, start-time, template
   
2. --count Optional.
   Number of items to return.

   Default:  50
   

list-attachment

crm dr-campaign list-attachment
  campaign_id
  [--fields]

1. campaign_id
2. --fields Optional.
   Default:  id, filename, content-type, size
   

   Valid values:  content-type, created-at, filename, id, size
   

list-contact

crm dr-campaign list-contact
  campaign_id
  [--email]
  [--fields]
  [--offset]
  [--count]

1. campaign_id
2. --email Optional.
3. --fields Optional.
   Default:  id, email, phone, send-email, send-sms, sends, views
   

   Valid values:  email, first-name, id, last-name, phone, send-email, send-sms, sends, views
   
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm dr-campaign log
  campaign_id
  [log_id]
  [--contact]
  [--fields]
  [--offset]
  [--count]

1. campaign_id
2. log_id Optional.
3. --contact Optional.
4. --fields Optional.
   Default:  id, created-at, event, email, message
   

   Valid values:  contact-id, created-at, email, event, id, message
   
5. --offset Optional.
   Paging offset.
6. --count Optional.
   Number of items to return.

   Default:  50
   

start

crm dr-campaign start
  campaign_id
  [--emails]
  [--resend]
  [--resend-sends]
  [--resend-views]

1. campaign_id
2. --emails Optional.
3. --resend Optional.
4. --resend-sends Optional.
5. --resend-views Optional.

set-default

crm dr-campaign set-default
  campaign_id

1. campaign_id

update

crm dr-campaign update
  campaign_id
  [--data]
  [--display-name]
  [--from]
  [--subject]
  [--sms-template]
  [--template]
  [--name]

1. campaign_id
2. --data Optional.
3. --display-name Optional.
4. --from Optional.
5. --subject Optional.
6. --sms-template Optional.
7. --template Optional.
8. --name Optional.

update-contact

crm dr-campaign update-contact
  contact_id
  [--send-email]
  [--no-send-email]
  [--send-sms]
  [--no-send-sms]

1. contact_id
2. --send-email Optional.
3. --no-send-email Optional.
4. --send-sms Optional.
5. --no-send-sms Optional.

---

dr-contact

Drow contacts
Sub commands: bulk-create, create, delete, get, list, unsubscribe, update

bulk-create

crm dr-contact bulk-create
  csv

1. csv

create

crm dr-contact create
  first_name
  last_name
  [--email]
  [--phone]
  [--data]

1. first_name
2. last_name
3. --email Optional.
4. --phone Optional.
5. --data Optional.

delete

crm dr-contact delete
  contact_id

1. contact_id

get

crm dr-contact get
  contact_id

1. contact_id

list

crm dr-contact list
  [--email]
  [--fields]
  [--bounced]
  [--normal]
  [--subscribed]
  [--unsubscribed]
  [--registered]
  [--unregistered]
  [--offset]
  [--count]

1. --email Optional.
2. --fields Optional.
   Default:  id, first-name, last-name, email, phone, bounce-status, unsubscribed
   

   Valid values:  birth-date, bounce-status, created-at, created-by, data, email, first-name, id, last-name, locale, modified-at, modified-by, phone, unsubscribed, user-id
   
3. --bounced Optional.
4. --normal Optional.
5. --subscribed Optional.
6. --unsubscribed Optional.
7. --registered Optional.
8. --unregistered Optional.
9. --offset Optional.
   Paging offset.
10. --count Optional.
    Number of items to return.

    Default:  50
    

unsubscribe

crm dr-contact unsubscribe
  contact_id

1. contact_id

update

crm dr-contact update
  contact_id
  [--birth-date]
  [--data]
  [--email]
  [--first-name]
  [--last-name]
  [--phone]

1. contact_id
2. --birth-date Optional.
3. --data Optional.
4. --email Optional.
5. --first-name Optional.
6. --last-name Optional.
7. --phone Optional.

---

ds-dashboard

Dashboard commands
Sub commands: create, delete, download, get, list, update, upload

create

crm ds-dashboard create
  name
  [--group-id]
  [--scope]

1. name
2. --group-id Optional.
3. --scope Optional.
   Valid values:  organization, participant
   

delete

crm ds-dashboard delete
  dashboard_id

1. dashboard_id

download

crm ds-dashboard download
  dashboard_id

1. dashboard_id

get

crm ds-dashboard get
  dashboard_id

1. dashboard_id

list

crm ds-dashboard list
  [--fields]
  [--group-id]
  [--scope]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, scope, created-at
   

   Valid values:  created-at, created-by, group-id, id, name, scope
   
2. --group-id Optional.
3. --scope Optional.
   Valid values:  organization, participant
   
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm ds-dashboard update
  dashboard_id
  [--name]
  [--scope]
  [--group-id]
  [--no-group-id]

1. dashboard_id
2. --name Optional.
3. --scope Optional.
   Valid values:  organization, participant
   
4. --group-id Optional.
5. --no-group-id Optional.

upload

crm ds-dashboard upload
  dashboard_id
  spec
  [--update]

1. dashboard_id
2. spec
3. --update Optional.

---

ds-jobspec

Job Spec commands
Sub commands: create, delete, get, get-run, get-run-output, list, list-run, run, set-default, sync, update

create

crm ds-jobspec create
  name
  class_name
  code
  [--dbm-database-id]

1. name
2. class_name
3. code
4. --dbm-database-id Optional.

delete

crm ds-jobspec delete
  spec_id

1. spec_id

get

crm ds-jobspec get
  spec_id
  [--args]
  [--code]
  [--widgets]

1. spec_id
2. --args Optional.
   Show args.
3. --code Optional.
   Show code.
4. --widgets Optional.
   Show widget specs.

get-run

crm ds-jobspec get-run
  run_id
  [--stdout]
  [--stderr]
  [--args]
  [--state]

1. run_id
2. --stdout Optional.
3. --stderr Optional.
4. --args Optional.
5. --state Optional.

get-run-output

crm ds-jobspec get-run-output
  run_id
  [--scope]

1. run_id
2. --scope Optional.

list

crm ds-jobspec list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, class, created-at
   

   Valid values:  args, args-schema, class, created-at, created-by, daily, dbm-database-id, id, monitored, name, organization-id, rrule, run-id, sched-id, scopes, start, user
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-run

crm ds-jobspec list-run
  spec_id
  [--offset]
  [--count]

1. spec_id
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

run

crm ds-jobspec run
  spec_id
  [--args]
  [--scope]
  [--wait]

1. spec_id
2. --args Optional.
3. --scope Optional.
4. --wait Optional.

set-default

crm ds-jobspec set-default
  spec_id

1. spec_id

sync

crm ds-jobspec sync
  spec_id

1. spec_id

update

crm ds-jobspec update
  spec_id
  [--args]
  [--branch]
  [--class]
  [--code]
  [--dbm-database-id]
  [--log-level]
  [--name]
  [--no-schedule-args]
  [--no-start]
  [--path]
  [--repo]
  [--rrule]
  [--schedule-args]
  [--schema]
  [--scopes]
  [--start]
  [--user]
  [--no-user]
  [--monitored]
  [--not-monitored]
  [--daily]
  [--no-daily]

1. spec_id
2. --args Optional.
3. --branch Optional.
4. --class Optional.
5. --code Optional.
6. --dbm-database-id Optional.
7. --log-level Optional.
   Valid values:  debug, info, warning, error, critical
   
8. --name Optional.
9. --no-schedule-args Optional.
10. --no-start Optional.
11. --path Optional.
12. --repo Optional.
13. --rrule Optional.
14. --schedule-args Optional.
15. --schema Optional.
16. --scopes Optional.
17. --start Optional.
18. --user Optional.
19. --no-user Optional.
20. --monitored Optional.
21. --not-monitored Optional.
22. --daily Optional.
23. --no-daily Optional.

---

ds-repo

Repository commands
Sub commands: create, get, list

create

crm ds-repo create
  name
  url
  [--key]

1. name
2. url
3. --key Optional.

get

crm ds-repo get
  repo_id

1. repo_id

list

crm ds-repo list
  [--offset]
  [--count]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   

---

ds-report

Report commands
Sub commands: create, delete, download, get, list, update

create

crm ds-report create
  name
  source
  [--args]
  [--description]
  [--display]
  [--fields]
  [--filters]
  [--sorts]

1. name
2. source
3. --args Optional.
4. --description Optional.
5. --display Optional.
6. --fields Optional.
7. --filters Optional.
8. --sorts Optional.

delete

crm ds-report delete
  report_id

1. report_id

download

crm ds-report download
  report_id

1. report_id

get

crm ds-report get
  report_id

1. report_id

list

crm ds-report list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, source, created-at
   

   Valid values:  args, created-at, created-by, description, display, fields, filters, groups, id, modified-at, modified-by, name, sorts, source
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm ds-report update
  report_id
  [--args]
  [--description]
  [--display]
  [--fields]
  [--filters]
  [--name]
  [--sorts]

1. report_id
2. --args Optional.
3. --description Optional.
4. --display Optional.
5. --fields Optional.
6. --filters Optional.
7. --name Optional.
8. --sorts Optional.

---

ds-table

Job Spec Table commands
Sub commands: add-field, create, delete, delete-field, get, list, query

add-field

crm ds-table add-field
  table_id
  name
  type
  [--options]

1. table_id
2. name
3. type
4. --options Optional.

create

crm ds-table create
  spec_id
  name
  [--field-name]
  [--field-type]
  [--options]
  [--schema]

1. spec_id
2. name
3. --field-name Optional.
4. --field-type Optional.
5. --options Optional.
6. --schema Optional.

delete

crm ds-table delete
  table_id

1. table_id

delete-field

crm ds-table delete-field
  table_id
  name

1. table_id
2. name

get

crm ds-table get
  table_id

1. table_id

list

crm ds-table list
  [--spec-id]
  [--fields]

1. --spec-id Optional.
2. --fields Optional.
   Default:  id, spec-id, name, fields
   

   Valid values:  created-at, fields, id, modified-at, name, spec-id
   

query

crm ds-table query
  table_id
  query

1. table_id
2. query

---

ds-widget

Widget commands
Sub commands: create, delete, get, get-output, get-raw-data, list, log, set-default, update

create

crm ds-widget create
  name
  spec_id
  dashboard_id

1. name
2. spec_id
3. dashboard_id

delete

crm ds-widget delete
  widget_id

1. widget_id

get

crm ds-widget get
  widget_id

1. widget_id

get-output

crm ds-widget get-output
  widget_id
  [--args]
  [--scope]

1. widget_id
2. --args Optional.
3. --scope Optional.

get-raw-data

crm ds-widget get-raw-data
  widget_id

1. widget_id

list

crm ds-widget list
  [--dashboard-id]
  [--fields]
  [--offset]
  [--count]

1. --dashboard-id Optional.
2. --fields Optional.
   Default:  id, name, type, spec-name
   

   Valid values:  args, created-at, created-by, dashboard-id, id, last-run-id, last-run-time, max-duration, name, position, refresh, spec-id, spec-name, title, type
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm ds-widget log
  widget_id
  [log_id]
  [--count]
  [--offset]

1. widget_id
2. log_id Optional.
3. --count Optional.
   Number of items to return.

   Default:  50
   
4. --offset Optional.
   Paging offset.

set-default

crm ds-widget set-default
  widget_id

1. widget_id

update

crm ds-widget update
  widget_id
  [--args]
  [--debug]
  [--no-debug]
  [--height]
  [--name]
  [--pylon-viewer-spec]
  [--title]
  [--ui-schema]
  [--width]
  [--x]
  [--y]

1. widget_id
2. --args Optional.
3. --debug Optional.
4. --no-debug Optional.
5. --height Optional.
6. --name Optional.
7. --pylon-viewer-spec Optional.
8. --title Optional.
9. --ui-schema Optional.
10. --width Optional.
11. --x Optional.
12. --y Optional.

---

ds-widgetspec

Widget Spec commands
Sub commands: create, delete, get, list, update

create

crm ds-widgetspec create
  name
  job_spec_id
  [--class-name]
  [--scope]
  [--type]

1. name
2. job_spec_id
3. --class-name Optional.
4. --scope Optional.
5. --type Optional.
   Valid values:  graph, html, markdown, metric, table
   

delete

crm ds-widgetspec delete
  spec_id

1. spec_id

get

crm ds-widgetspec get
  spec_id

1. spec_id

list

crm ds-widgetspec list
  [--job-spec-id]
  [--offset]
  [--count]

1. --job-spec-id Optional.
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm ds-widgetspec update
  spec_id
  [--allow-refresh]
  [--args-schema]
  [--class-name]
  [--job-spec-id]
  [--layout-schema]
  [--name]
  [--scope]
  [--type]

1. spec_id
2. --allow-refresh Optional.
   Valid values:  yes, no
   
3. --args-schema Optional.
4. --class-name Optional.
5. --job-spec-id Optional.
6. --layout-schema Optional.
7. --name Optional.
8. --scope Optional.
9. --type Optional.
   Valid values:  graph, html, markdown, metric, table
   

---

es-spec

Elastic search spec management
Sub commands: get, list, list-version

get

crm es-spec get
  spec_id

1. spec_id

list

crm es-spec list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, modified-at, version-name
   

   Valid values:  created-at, created-by, id, modified-at, modified-by, name, version-description, version-id, version-name
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-version

crm es-spec list-version
  spec_id
  [--fields]
  [--name]
  [--offset]
  [--count]

1. spec_id
2. --fields Optional.
   Default:  id, name, description, modified-at
   

   Valid values:  created-at, created-by, description, id, index-last-collection-at, index-status, modified-at, modified-by, name
   
3. --name Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

---

fm-instance

Form instance management
Sub commands: create, delete, get, list, update

create

crm fm-instance create
  individual_id
  [--assign-individual]
  [--description]
  [--spec-id]
  [--version-id]

1. individual_id
2. --assign-individual Optional.
3. --description Optional.
4. --spec-id Optional.
5. --version-id Optional.

delete

crm fm-instance delete
  instance_id

1. instance_id

get

crm fm-instance get
  instance_id
  [--spec-info]

1. instance_id
2. --spec-info Optional.

list

crm fm-instance list
  [--fields]
  [--offset]
  [--count]
  [--individual]
  [--internal]
  [--state]

1. --fields Optional.
   Default:  id, individual-id, modified-at, name
   

   Valid values:  created-at, created-by, description, id, individual-id, internal, modified-at, modified-by, name, spec-id, state, url, url-expires, version-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   
4. --individual Optional.
5. --internal Optional.
6. --state Optional.
   Valid values:  completed, created, started
   

update

crm fm-instance update
  instance_id
  [--assign-individual]
  [--unassign-individual]
  [--description]
  [--notify]
  [--no-notify]

1. instance_id
2. --assign-individual Optional.
3. --unassign-individual Optional.
4. --description Optional.
5. --notify Optional.
6. --no-notify Optional.

---

fm-spec

Form spec management
Sub commands: add-version, create, delete, get, get-schema, list, list-version, update, update-version

add-version

crm fm-spec add-version
  spec_id
  form_schema
  response_schema
  [--current]
  [--description]

1. spec_id
2. form_schema
3. response_schema
4. --current Optional.
5. --description Optional.

create

crm fm-spec create
  name
  [--internal]
  [--no-internal]
  [--type]

1. name
2. --internal Optional.
3. --no-internal Optional.
4. --type Optional.
   Default:  standard
   

   Valid values:  standard, participant-extension
   

delete

crm fm-spec delete
  spec_id

1. spec_id

get

crm fm-spec get
  spec_id
  [--version]

1. spec_id
2. --version Optional.

get-schema

crm fm-spec get-schema
  spec_id
  [--version]

1. spec_id
2. --version Optional.

list

crm fm-spec list
  [--fields]
  [--internal]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, ui-managed, modified-at, version-name
   

   Valid values:  created-at, created-by, id, internal, modified-at, modified-by, name, type, ui-managed, version-id, version-name
   
2. --internal Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

list-version

crm fm-spec list-version
  spec_id
  [--name]
  [--fields]
  [--offset]
  [--count]

1. spec_id
2. --name Optional.
3. --fields Optional.
   Default:  id, name, description, modified-at
   

   Valid values:  created-at, created-by, description, id, modified-at, modified-by, name
   
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm fm-spec update
  spec_id
  [--name]
  [--version]
  [--internal]
  [--no-internal]
  [--ui-managed]
  [--no-ui-managed]
  [--type]

1. spec_id
2. --name Optional.
3. --version Optional.
4. --internal Optional.
5. --no-internal Optional.
6. --ui-managed Optional.
7. --no-ui-managed Optional.
8. --type Optional.
   Valid values:  standard, participant-extension
   

update-version

crm fm-spec update-version
  version
  [--description]

1. version
2. --description Optional.

---

gm-log

Gemfire log commands
Sub commands: create, get, get-job, list, list-job, sync

create

crm gm-log create
  payload

1. payload

get

crm gm-log get
  log_id
  [--payload]

1. log_id
2. --payload Optional.

get-job

crm gm-log get-job
  log_id

1. log_id

list

crm gm-log list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, last-modified-at, type, event, state
   

   Valid values:  created-at, credential-id, event, id, key, last-modified-at, state, type
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-job

crm gm-log list-job
  [--fields]
  [--object]
  [--region]

1. --fields Optional.
   Default:  id, created-at, type, key, region
   

   Valid values:  created-at, expired-at, id, key, region, type
   
2. --object Optional.
3. --region Optional.

sync

crm gm-log sync
  log_id

1. log_id

---

gm-task

Gemfire task commands
Sub commands: create, get

create

crm gm-task create
  method
  [--kwargs]

1. method
2. --kwargs Optional.

get

crm gm-task get
  task_id

1. task_id

---

id-archive

Manage identity archive requests
Sub commands: list

list

crm id-archive list
  [--fields]
  [--individual-id]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  created-time, individual-id, email, request-state
   

   Valid values:  created-by, created-time, email, individual-id, interview-id, modified-time, request-state
   
2. --individual-id Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

---

id-code

Signup code management
Sub commands: create, delete, get, list

create

crm id-code create
  code
  group_id

1. code
2. group_id

delete

crm id-code delete
  code

1. code

get

crm id-code get
  code

1. code

list

crm id-code list

---

id-email

Identity email template management
Sub commands: create, delete, download, get, list, update, upload

create

crm id-email create
  format
  locale
  type
  template
  [--theme]

1. format
   Valid values:  html, txt
   
2. locale
   Valid values:  en_US, es_US
   
3. type
   Valid values:  forgot-password, messaging-patient, messaging-provider, onboarding, onboarding-code, onboarding-provider, reverify-email, verify-email
   
4. template
5. --theme Optional.

delete

crm id-email delete
  template_id

1. template_id

download

crm id-email download
  directory
  [--organization]
  [--theme]

1. directory
2. --organization Optional.
3. --theme Optional.

get

crm id-email get
  template_id
  [--template]

1. template_id
2. --template Optional.

list

crm id-email list
  [--fields]
  [--organization]
  [--theme]

1. --fields Optional.
   Default:  id, type, locale, format, organization-id, theme-id
   

   Valid values:  created-at, format, id, locale, modified-at, organization-id, subject, support, support-title, theme-id, type
   
2. --organization Optional.
3. --theme Optional.

update

crm id-email update
  template_id
  [--format]
  [--locale]
  [--subject]
  [--support-email]
  [--support-title]
  [--template]
  [--type]

1. template_id
2. --format Optional.
   Valid values:  html, txt
   
3. --locale Optional.
   Valid values:  en_US, es_US
   
4. --subject Optional.
5. --support-email Optional.
6. --support-title Optional.
7. --template Optional.
8. --type Optional.
   Valid values:  forgot-password, messaging-patient, messaging-provider, onboarding, onboarding-code, onboarding-provider, reverify-email, verify-email
   

upload

crm id-email upload
  directory
  [--organization]
  [--theme]
  [--force-update]

1. directory
2. --organization Optional.
3. --theme Optional.
4. --force-update Optional.

---

id-email-logs

Outgoing email logs
Sub commands: list

list

crm id-email-logs list
  [--destination]
  [--fields]

1. --destination Optional.
   Destination email address.
2. --fields Optional.
   Default:  id, timestamp, destination, notification-type, subject
   

   Valid values:  bounce-subtype, bounce-type, destination, event-received, id, notification-type, ses-id, ses-raw, source, subject, timestamp
   

---

id-feature

Identity feature management
Sub commands: add-org, add-user, create, delete, delete-org, delete-user, get, list, list-org, list-user, update, update-org, update-user

add-org

crm id-feature add-org
  feature
  [--state]
  [--force]

1. feature
2. --state Optional.
   Default:  enabled
   

   Valid values:  enabled, disabled, dontcare
   
3. --force Optional.

add-user

crm id-feature add-user
  feature
  user_id
  [--org]
  [--no-org]
  [--state]
  [--force]

1. feature
2. user_id
3. --org Optional.
4. --no-org Optional.
5. --state Optional.
   Default:  enabled
   

   Valid values:  enabled, disabled, dontcare
   
6. --force Optional.

create

crm id-feature create
  feature
  description
  [--assignable]
  [--global]
  [--no-global]
  [--stage]

1. feature
2. description
3. --assignable Optional.
4. --global Optional.
5. --no-global Optional.
6. --stage Optional.
   Valid values:  alpha, beta, released
   

delete

crm id-feature delete
  feature
  [--force]

1. feature
2. --force Optional.

delete-org

crm id-feature delete-org
  feature

1. feature

delete-user

crm id-feature delete-user
  feature
  user_id

1. feature
2. user_id

get

crm id-feature get
  feature

1. feature

list

crm id-feature list
  [--offset]
  [--count]
  [--user]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   
3. --user Optional.

list-org

crm id-feature list-org
  [--offset]
  [--count]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   

list-user

crm id-feature list-user
  user_id
  [--offset]
  [--count]

1. user_id
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm id-feature update
  feature
  [--assignable]
  [--no-assignable]
  [--description]
  [--global]
  [--no-global]
  [--stage]

1. feature
2. --assignable Optional.
3. --no-assignable Optional.
4. --description Optional.
5. --global Optional.
6. --no-global Optional.
7. --stage Optional.
   Valid values:  alpha, beta, released
   

update-user

crm id-feature update-user
  feature
  user_id
  [--state]
  [--force]

1. feature
2. user_id
3. --state Optional.
   Valid values:  enabled, disabled, dontcare
   
4. --force Optional.

update-org

crm id-feature update-org
  feature
  [--state]
  [--force]

1. feature
2. --state Optional.
   Valid values:  enabled, disabled, dontcare
   
3. --force Optional.

---

id-group

Identity group management
Sub commands: add-leader, create, delete, delete-leader, get, list, log, move, update

add-leader

crm id-group add-leader
  group_id
  user_id

1. group_id
2. user_id

create

crm id-group create
  name
  type

1. name
2. type
   Valid values:  regular, provider_only
   

delete

crm id-group delete
  group_id

1. group_id

delete-leader

crm id-group delete-leader
  group_id
  user_id

1. group_id
2. user_id

get

crm id-group get
  group_id

1. group_id

list

crm id-group list
  [--fields]
  [--inactive]
  [--individual]
  [--leader]
  [--name]
  [--parent-id]
  [--search]
  [--type]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, type, individual-count, active
   

   Valid values:  active, child-count, id, individual-count, leader-count, modified-at, name, node-type, organization-id, parent-id, parent-name, type
   
2. --inactive Optional.
3. --individual Optional.
4. --leader Optional.
5. --name Optional.
6. --parent-id Optional.
7. --search Optional.
8. --type Optional.
   Valid values:  regular, provider_only
   
9. --offset Optional.
   Paging offset.
10. --count Optional.
    Number of items to return.

    Default:  50
    

log

crm id-group log
  [group]
  [--individual]
  [--fields]
  [--offset]
  [--count]

1. group Optional.
2. --individual Optional.
3. --fields Optional.
   Default:  individual-group-id, individual-id, event, subject, created-at
   

   Valid values:  created-at, event, id, individual-group-id, individual-id, subject
   
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

move

crm id-group move
  group_id
  to_parent_group_id
  [--wait]

1. group_id
2. to_parent_group_id
3. --wait Optional.
   Wait for task completion.

update

crm id-group update
  group_id
  [--name]

1. group_id
2. --name Optional.

---

id-org

Identity organization management
Sub commands: add-role-user, add-user, create, delete-role-user, get, list, list-role-user, set-default, show, update

create

crm id-org create
  name
  [--classification]
  [--display]
  [--type]
  [--timezone]

1. name
2. --classification Optional.
   Default:  customer
   

   Valid values:  carium, customer, carium-test, customer-test
   
3. --display Optional.
4. --type Optional.
   Default:  coach
   

   Valid values:  coach, provider
   
5. --timezone Optional.

add-user

crm id-org add-user
  username

1. username

add-role-user

crm id-org add-role-user
  role
  username

1. role
2. username

delete-role-user

crm id-org delete-role-user
  role
  username

1. role
2. username

get

crm id-org get
  [organization_id]

1. organization_id Optional.

list

crm id-org list
  [--fields]
  [--name]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, display, modified-at
   

   Valid values:  active, classification, display, id, logo, modified-at, name, theme, timezone, type
   
2. --name Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

list-role-user

crm id-org list-role-user
  role

1. role

set-default

crm id-org set-default
  organization_id

1. organization_id

show

crm id-org show

update

crm id-org update
  organization_id
  [--classification]
  [--display]
  [--name]
  [--theme]
  [--timezone]
  [--type]

1. organization_id
2. --classification Optional.
3. --display Optional.
4. --name Optional.
5. --theme Optional.
6. --timezone Optional.
7. --type Optional.

---

id-registration

Registration Invite
Sub commands: create, list

list

crm id-registration list
  [--offset]
  [--count]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   

create

crm id-registration create
  email

1. email

---

id-sms

Identity sms template management
Sub commands: create, delete, download, get, list, update, upload

create

crm id-sms create
  locale
  type
  template
  [--theme]

1. locale
   Valid values:  en_US, es_US
   
2. type
   Valid values:  reset-password, onboarding, onboarding-code, onboarding-provider, verify
   
3. template
4. --theme Optional.

delete

crm id-sms delete
  template_id

1. template_id

download

crm id-sms download
  directory
  [--organization]
  [--theme]

1. directory
2. --organization Optional.
3. --theme Optional.

get

crm id-sms get
  template_id
  [--template]

1. template_id
2. --template Optional.

list

crm id-sms list
  [--fields]
  [--organization]
  [--theme]

1. --fields Optional.
   Default:  id, type, locale, organization-id, theme-id
   

   Valid values:  created-at, id, locale, modified-at, organization-id, theme-id, type
   
2. --organization Optional.
3. --theme Optional.

update

crm id-sms update
  template_id
  [--locale]
  [--template]
  [--type]

1. template_id
2. --locale Optional.
   Valid values:  en_US, es_US
   
3. --template Optional.
4. --type Optional.
   Valid values:  reset-password, onboarding, onboarding-code, onboarding-provider, verify
   

upload

crm id-sms upload
  directory
  [--organization]
  [--theme]
  [--force-update]

1. directory
2. --organization Optional.
3. --theme Optional.
4. --force-update Optional.

---

id-task

Identity task management
Sub commands: get

get

crm id-task get
  task_id

1. task_id

---

id-theme

Manage identity organization theme
Sub commands: create, delete, get, list, update

create

crm id-theme create
  domain
  support_email_name
  [--support-email]

1. domain
2. support_email_name
3. --support-email Optional.
   Default:  support@carium.com
   

delete

crm id-theme delete
  theme_id

1. theme_id

get

crm id-theme get
  theme_id

1. theme_id

list

crm id-theme list
  [--fields]
  [--domain]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, domain, support-email, support-email-name
   

   Valid values:  created-by, created-time, domain, id, modified-by, modified-time, support-email, support-email-name
   
2. --domain Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm id-theme update
  theme_id
  [--domain]
  [--support-email]
  [--support-email-name]

1. theme_id
2. --domain Optional.
3. --support-email Optional.
4. --support-email-name Optional.

---

id-user

Identity user management
Sub commands: archive, change-password, clear-password-reset-required, confirm-forgot-password, create, disable, enable, forgot-password, get, list, set-password-reset-required, share, unshare, update

archive

crm id-user archive
  user_id
  [--delete]

1. user_id
2. --delete Optional.

clear-password-reset-required

crm id-user clear-password-reset-required
  user_id

1. user_id

change-password

crm id-user change-password
  user_id
  [--context]
  [--old-password]
  [--new-password]
  [--maintain-active-sessions]
  [--no-maintain-active-sessions]

1. user_id
2. --context Optional.
   Valid values:  carium-support
   
3. --old-password Optional.
4. --new-password Optional.
5. --maintain-active-sessions Optional.
6. --no-maintain-active-sessions Optional.

confirm-forgot-password

crm id-user confirm-forgot-password
  user_id
  code
  [--password]

1. user_id
2. code
3. --password Optional.

create

crm id-user create
  birth_date
  first_name
  last_name
  [--auto-confirm]
  [--email]
  [--gender]
  [--locale]
  [--password]
  [--phone]
  [--preferred-name]

1. birth_date
2. first_name
3. last_name
4. --auto-confirm Optional.
5. --email Optional.
6. --gender Optional.
   Default:  unknown
   
7. --locale Optional.
   Default:  en_US
   
8. --password Optional.
9. --phone Optional.
10. --preferred-name Optional.

disable

Disable a user

crm id-user disable
  user_id

1. user_id

enable

Enable a user

crm id-user enable
  user_id

1. user_id

forgot-password

crm id-user forgot-password
  user_id
  [--locale]

1. user_id
2. --locale Optional.
   Valid values:  en_US, es_US
   

get

crm id-user get
  user_id
  [--details]
  [--all-details]
  [--details-signups-with-code]

1. user_id
2. --details Optional.
   Default:  
   

   Valid values:  badge_count, devices, groups, homefeed, journals, messages, recent_metrics, roles, signups, timeseries
   
3. --all-details Optional.
4. --details-signups-with-code Optional.

list

crm id-user list
  [--offset]
  [--count]
  [--email]
  [--fields]
  [--individual]
  [--organization]
  [--phone]
  [--query]
  [--shared-with]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   
3. --email Optional.
4. --fields Optional.
   Default:  id, username, name, birthdate, timezone
   

   Valid values:  birthdate, created-at, email, enabled, id, individual-id, locale, locale-explicit, modified-at, name, organization-id, phone, registration-time, status, timezone, timezone-explicit, username, verified
   
5. --individual Optional.
6. --organization Optional.
7. --phone Optional.
8. --query Optional.
9. --shared-with Optional.

share

crm id-user share
  individual_id
  [--share-with]

1. individual_id
2. --share-with Optional.

set-password-reset-required

crm id-user set-password-reset-required
  user_id

1. user_id

unshare

crm id-user unshare
  individual_id

1. individual_id

update

crm id-user update
  user_id
  [--email]
  [--first-name]
  [--last-name]
  [--locale]
  [--phone]
  [--tz]
  [--username]

1. user_id
2. --email Optional.
3. --first-name Optional.
4. --last-name Optional.
5. --locale Optional.
6. --phone Optional.
7. --tz Optional.
8. --username Optional.
   Valid values:  email, phone
   

---

it-device

Device debugger
Sub commands: bt-reading, sm-reading, sm-validate

bt-reading

crm it-device bt-reading
  imei
  start_time

1. imei
2. start_time

sm-reading

crm it-device sm-reading
  device_id
  start_time
  end_time

1. device_id
2. start_time
3. end_time

sm-validate

crm it-device sm-validate
  device_id

1. device_id

---

it-ltemaps

Integrator LTE Maps commands
Sub commands: create, delete, list, sync

list

crm it-ltemaps list
  map_type
  [--individual]
  [--organization]
  [--devicetype]
  [--deviceid]
  [--hwideviceid]
  [--imei]
  [--offset]
  [--count]

1. map_type
   Valid values:  bodytrace, smartmeter, tenovi, alio
   
2. --individual Optional.
3. --organization Optional.
4. --devicetype Optional.
5. --deviceid Optional.
6. --hwideviceid Optional.
7. --imei Optional.
8. --offset Optional.
   Paging offset.
9. --count Optional.
   Number of items to return.

   Default:  50
   

create

crm it-ltemaps create
  map_type
  device_id
  individual_id

1. map_type
2. device_id
3. individual_id

delete

crm it-ltemaps delete
  map_type
  _id

1. map_type
   Valid values:  bodytrace, smartmeter, tenovi, alio
   
2. _id

sync

crm it-ltemaps sync
  map_type
  _id

1. map_type
   Valid values:  bodytrace, smartmeter, tenovi, alio
   
2. _id

---

it-oauth

Integrator Oauth commands
Sub commands: add-feature, create-config, delete-config, list-config, list-types, remove-feature

list-types

crm it-oauth list-types
  individual
  [--type]
  [--details]

1. individual
2. --type Optional.
3. --details Optional.

create-config

crm it-oauth create-config
  individual
  type
  [--fetch-history-days]
  [--fetch-history-months]

1. individual
2. type
3. --fetch-history-days Optional.
   Default:  7
   
4. --fetch-history-months Optional.
   Default:  12
   

list-config

crm it-oauth list-config
  [--type]
  [--individual]
  [--limit]
  [--offset]

1. --type Optional.
2. --individual Optional.
3. --limit Optional.
   Default:  25
   
4. --offset Optional.
   Paging offset.

delete-config

crm it-oauth delete-config
  _id

1. _id

add-feature

crm it-oauth add-feature
  individual
  type
  feature

1. individual
2. type
3. feature

remove-feature

crm it-oauth remove-feature
  _id

1. _id

---

it-shipment

Device shipment management
Sub commands: get, list, update

get

crm it-shipment get
  _id

1. _id

list

crm it-shipment list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, tracking-id, tracking-status, tracking-time
   

   Valid values:  created-at, id, modified-at, order-id, order-notes, shipper, tracked, tracking-id, tracking-log, tracking-status, tracking-time
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm it-shipment update
  _id
  [--order-individual]
  [--order-notes]
  [--shipper]
  [--tracked]
  [--tracking-id]
  [--tracking-status]

1. _id
2. --order-individual Optional.
3. --order-notes Optional.
4. --shipper Optional.
5. --tracked Optional.
6. --tracking-id Optional.
7. --tracking-status Optional.

---

iv-instance

Interview instance management
Sub commands: answer, create, delete, get, list, start, stop, update

answer

crm iv-instance answer
  interview_id
  value

1. interview_id
2. value

create

crm iv-instance create
  profile_name
  individual_id
  [--auto-open]
  [--no-auto-open]
  [--auto-start]
  [--no-auto-start]
  [--blocking]
  [--no-blocking]
  [--dismissible]
  [--no-dismissible]
  [--expired-at]
  [--external-data]
  [--version]

1. profile_name
2. individual_id
3. --auto-open Optional.
4. --no-auto-open Optional.
5. --auto-start Optional.
6. --no-auto-start Optional.
7. --blocking Optional.
8. --no-blocking Optional.
9. --dismissible Optional.
10. --no-dismissible Optional.
11. --expired-at Optional.
12. --external-data Optional.
13. --version Optional.

delete

crm iv-instance delete
  interview_id

1. interview_id

get

crm iv-instance get
  interview_id

1. interview_id

list

crm iv-instance list
  [--fields]
  [--auto-open]
  [--no-auto-open]
  [--profile]
  [--individual]
  [--state]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, profile, created-at, state
   

   Valid values:  auto-open, blocking, created-at, created-by, dismissed, dismissible, expired-at, id, individual-id, profile, profile-id, state
   
2. --auto-open Optional.
3. --no-auto-open Optional.
4. --profile Optional.
5. --individual Optional.
6. --state Optional.
7. --offset Optional.
   Paging offset.
8. --count Optional.
   Number of items to return.

   Default:  50
   

start

crm iv-instance start
  interview_id

1. interview_id

stop

crm iv-instance stop
  interview_id

1. interview_id

update

crm iv-instance update
  interview_id
  [--external-data]

1. interview_id
2. --external-data Optional.

---

iv-profile

Workflow profile management
Sub commands: add-version, create, delete, get, get-graph, list, update

add-version

crm iv-profile add-version
  profile_id
  spec

1. profile_id
2. spec

create

crm iv-profile create
  name

1. name

delete

crm iv-profile delete
  profile_id

1. profile_id

get

crm iv-profile get
  profile_id
  [--version]

1. profile_id
2. --version Optional.

get-graph

crm iv-profile get-graph
  profile_id
  [--png]

1. profile_id
2. --png Optional.

list

crm iv-profile list
  [--fields]
  [--type]
  [--ui]
  [--no-ui]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, default-version, ui-managed, modified-at
   

   Valid values:  auto-open, blocking, count, count-finished, count-in-progress, created-at, created-by, default-version, description, display, id, modified-at, modified-by, name, retake, type, ui-managed
   
2. --type Optional.
3. --ui Optional.
4. --no-ui Optional.
5. --offset Optional.
   Paging offset.
6. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm iv-profile update
  profile_id
  [--auto-open]
  [--no-auto-open]
  [--blocking]
  [--no-blocking]
  [--retake]
  [--no-retake]
  [--ui-managed]
  [--no-ui-managed]
  [--description]
  [--display-name]
  [--name]
  [--type]

1. profile_id
2. --auto-open Optional.
3. --no-auto-open Optional.
4. --blocking Optional.
5. --no-blocking Optional.
6. --retake Optional.
7. --no-retake Optional.
8. --ui-managed Optional.
9. --no-ui-managed Optional.
10. --description Optional.
11. --display-name Optional.
12. --name Optional.
13. --type Optional.
    Valid values:  general, internal
    

---

j2

jinja2 template rendering

---

jb-test

Job tester commands
Sub commands: run-download, run-event, run-report, run-view, sql, unittest

run-download

crm jb-test run-download
  spec_id
  file
  class_name
  output
  [--report]
  [--run-id]
  [--scope]
  [--use-dynamic-table]
  [--widget-args]
  [--widget-height]
  [--widget-name]
  [--widget-width]
  [--widget-x]
  [--widget-y]

1. spec_id
2. file
3. class_name
4. output
5. --report Optional.
6. --run-id Optional.
7. --scope Optional.
8. --use-dynamic-table Optional.
9. --widget-args Optional.
10. --widget-height Optional.
11. --widget-name Optional.
12. --widget-width Optional.
13. --widget-x Optional.
14. --widget-y Optional.

run-event

crm jb-test run-event
  spec_id
  file
  class_name
  input
  [--direct-api]
  [--memory-summary]
  [--module-dir]
  [--profile]

1. spec_id
2. file
3. class_name
4. input
5. --direct-api Optional.
6. --memory-summary Optional.
7. --module-dir Optional.
8. --profile Optional.

run-report

crm jb-test run-report
  spec_id
  file
  class_name
  [--output]
  [--run-args]
  [--run-id]
  [--scope]

1. spec_id
2. file
3. class_name
4. --output Optional.
5. --run-args Optional.
6. --run-id Optional.
7. --scope Optional.

run-view

crm jb-test run-view
  spec_id
  file
  class_name
  [--report]
  [--run-id]
  [--scope]
  [--use-dynamic-table]
  [--widget-args]
  [--widget-height]
  [--widget-name]
  [--widget-width]
  [--widget-x]
  [--widget-y]

1. spec_id
2. file
3. class_name
4. --report Optional.
5. --run-id Optional.
6. --scope Optional.
7. --use-dynamic-table Optional.
8. --widget-args Optional.
9. --widget-height Optional.
10. --widget-name Optional.
11. --widget-width Optional.
12. --widget-x Optional.
13. --widget-y Optional.

sql

crm jb-test sql
  sql
  [--database]
  [--verbose]

1. sql
2. --database Optional.
   Default:  redshift
   
3. --verbose Optional.

unittest

crm jb-test unittest
  test_module

1. test_module

---

lc-entries

Lachesis time-series commands
Sub commands: clean, create, delete, delete-source, list, list-meta, list-source

clean

crm lc-entries clean
  type
  [--individual]

1. type
2. --individual Optional.

create

crm lc-entries create
  type
  value
  [--context]
  [--individual]
  [--time]
  [--source]

1. type
2. value
3. --context Optional.
4. --individual Optional.
5. --time Optional.
6. --source Optional.
   Default:  manual
   

delete

crm lc-entries delete
  type
  time
  [--individual]

1. type
2. time
3. --individual Optional.

delete-source

crm lc-entries delete-source
  source_id
  [--no-wait/-n]

1. source_id
2. --no-wait/-n Optional.

list

crm lc-entries list
  type
  [--context]
  [--end-time]
  [--individual]
  [--source]
  [--start-time]
  [--delete]
  [--offset]
  [--count]

1. type
2. --context Optional.
3. --end-time Optional.
4. --individual Optional.
5. --source Optional.
6. --start-time Optional.
7. --delete Optional.
8. --offset Optional.
   Paging offset.
9. --count Optional.
   Number of items to return.

   Default:  50
   

list-meta

crm lc-entries list-meta
  [--individual]

1. --individual Optional.

list-source

crm lc-entries list-source
  [--fields]
  [--individual]
  [--source]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, type, source, organization
   

   Valid values:  id, organization, registered-at, series-id, source, type
   
2. --individual Optional.
3. --source Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

---

lc-tca

Lachesis TCA management
Sub commands: delete, list

delete

crm lc-tca delete
  tca_id

1. tca_id

list

crm lc-tca list
  [--individual]
  [--alerter-type]

1. --individual Optional.
2. --alerter-type Optional.
   Default:  Range
   

   Valid values:  Range, Watermark
   

---

login

Login command

---

logout

Logout command

---

pg-design

Design related commands
Sub commands: create, delete, download, export, get, import, list, set-default, upload, validate

create

crm pg-design create
  name

1. name

delete

crm pg-design delete
  design_id

1. design_id

download

crm pg-design download
  design_id
  [output]

1. design_id
2. output Optional.
   If not specified, will create the files in cwd.

export

crm pg-design export
  design_id
  wftype_id

1. design_id
2. wftype_id

get

crm pg-design get
  design_id
  [--section]

1. design_id
2. --section Optional.
   Valid values:  design, state, event, interaction
   

import

crm pg-design import
  design_id
  wftype_id
  [--wf-version]

1. design_id
2. wftype_id
3. --wf-version Optional.

list

crm pg-design list
  [--offset]
  [--count]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   

set-default

crm pg-design set-default
  design_id

1. design_id

upload

crm pg-design upload
  design_id
  [input]

1. design_id
2. input Optional.
   If not specified, will upload the files from cwd.

validate

crm pg-design validate
  design_id
  realm_id

1. design_id
2. realm_id

---

pg-interaction

Interaction-related commands
Sub commands: get

get

crm pg-interaction get
  interaction_id
  [--section]

1. interaction_id
2. --section Optional.
   Valid values:  interaction, invocation, action
   

---

pg-realm

Realm management
Sub commands: create, delete, get, list, set-default, update-args

create

crm pg-realm create
  design_id
  name
  [--time]
  [--args]

1. design_id
2. name
3. --time Optional.
4. --args Optional.

delete

crm pg-realm delete
  realm_id

1. realm_id

get

crm pg-realm get
  realm_id

1. realm_id

list

crm pg-realm list
  design_id
  [--offset]
  [--count]

1. design_id
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

set-default

crm pg-realm set-default
  realm_id

1. realm_id

update-args

crm pg-realm update-args
  realm_id
  args

1. realm_id
2. args

---

pg-sim

Playground simulation related commands
Sub commands: change-time, create, create-object, delete, get, get-object, list, list-objects, start

change-time

crm pg-sim change-time
  sim_id
  time

1. sim_id
2. time
   absolute (2010-01-01 00:00:00) or relative ("1 days 01:00:00", "-01", "-01:00:00").

create

crm pg-sim create
  realm_id
  profile_id
  [--name]
  [--version]

1. realm_id
2. profile_id
3. --name Optional.
4. --version Optional.

create-object

crm pg-sim create-object
  sim_id
  service
  type
  content

1. sim_id
2. service
3. type
4. content

delete

crm pg-sim delete
  sim_id

1. sim_id

get

crm pg-sim get
  sim_id

1. sim_id

get-object

crm pg-sim get-object
  obj_id

1. obj_id

list

crm pg-sim list
  [--offset]
  [--count]
  [--inactive]
  [--name]

1. --offset Optional.
   Paging offset.
2. --count Optional.
   Number of items to return.

   Default:  50
   
3. --inactive Optional.
4. --name Optional.

list-objects

crm pg-sim list-objects
  sim_id
  [--service]
  [--type]

1. sim_id
2. --service Optional.
3. --type Optional.

start

crm pg-sim start
  sim_id

1. sim_id

---

pk-bundle

Package bundle manager
Sub commands: diff, download, init, show, upload

diff

crm pk-bundle diff
  section
  [--filter]

1. section
   Valid values:  announcer, article, careplan, dashboard, event, feature, form, pathway, survey, theme, workflow
   
2. --filter Optional.

download

crm pk-bundle download
  section
  [--filter]

1. section
   Valid values:  announcer, article, careplan, dashboard, event, feature, form, pathway, survey, theme, workflow
   
2. --filter Optional.

init

crm pk-bundle init
  [--path]
  [--reset]

1. --path Optional.
2. --reset Optional.

show

crm pk-bundle show

upload

crm pk-bundle upload
  section
  [--filter]
  [--override]

1. section
   Valid values:  announcer, article, careplan, dashboard, event, feature, form, pathway, survey, theme, workflow
   
2. --filter Optional.
3. --override Optional.

---

pw-instance

Pathway instance management
Sub commands: delete, get, list, log, set-stage, update

delete

crm pw-instance delete
  instance_id

1. instance_id

get

crm pw-instance get
  instance_id
  [--store-schema]

1. instance_id
2. --store-schema Optional.

list

crm pw-instance list
  [--fields]
  [--individual]
  [--spec]
  [--state]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, created-at, state, version-name
   

   Valid values:  created-at, created-by, id, individual-id, modified-at, name, state, version-name
   
2. --individual Optional.
3. --spec Optional.
4. --state Optional.
   Valid values:  archived, completed, created, started
   
5. --offset Optional.
   Paging offset.
6. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm pw-instance log
  instance_id
  [log_id]
  [--fields]
  [--filter]
  [--log-level]
  [--step]
  [--offset]
  [--count]

1. instance_id
2. log_id Optional.
3. --fields Optional.
   Default:  id, created-at, level, step-name, user-name, message
   

   Valid values:  created-at, id, level, message, step-name, user-name
   
4. --filter Optional.
5. --log-level Optional.
   Valid values:  debug, info, warning, error, critical
   
6. --step Optional.
7. --offset Optional.
   Paging offset.
8. --count Optional.
   Number of items to return.

   Default:  50
   

set-stage

crm pw-instance set-stage
  instance_id
  stage

1. instance_id
2. stage

update

crm pw-instance update
  instance_id
  [--description]
  [--store-schema]

1. instance_id
2. --description Optional.
3. --store-schema Optional.

---

pw-spec

Pathway spec management
Sub commands: create, create-stage, create-stage-link, create-step, delete, dump, get, list, list-stage, list-step, load, update

create

crm pw-spec create
  name
  [--allow-duplicate]

1. name
2. --allow-duplicate Optional.

create-stage

crm pw-spec create-stage
  spec_id
  name
  title

1. spec_id
2. name
3. title

create-stage-link

crm pw-spec create-stage-link
  stage1_id
  stage2_id

1. stage1_id
2. stage2_id

create-step

crm pw-spec create-step
  stage_id
  name
  title
  [--type]

1. stage_id
2. name
3. title
4. --type Optional.
   Default:  basic.Action
   

delete

crm pw-spec delete
  spec_id

1. spec_id

dump

crm pw-spec dump
  spec_id

1. spec_id

get

crm pw-spec get
  spec_id

1. spec_id

load

crm pw-spec load
  spec_id
  model

1. spec_id
2. model

list

crm pw-spec list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, modified-at, version-name
   

   Valid values:  created-at, created-by, id, modified-at, modified-by, name, version-id, version-name
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-stage

crm pw-spec list-stage
  spec_id
  [--fields]
  [--offset]
  [--count]

1. spec_id
2. --fields Optional.
   Default:  id, name, title, links
   

   Valid values:  created-at, created-by, id, links, modified-at, modified-by, name, title
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

list-step

crm pw-spec list-step
  stage_id
  [--fields]
  [--offset]
  [--count]

1. stage_id
2. --fields Optional.
   Default:  id, name, type
   

   Valid values:  created-at, created-by, description, id, modified-at, modified-by, name, necessity, title, type
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm pw-spec update
  version_id
  [--description]
  [--store-schema]

1. version_id
2. --description Optional.
3. --store-schema Optional.

---

pw-step

Pathway step management
Sub commands: get, list-reminder, set-state, trigger-reminder, update

get

crm pw-step get
  step_id

1. step_id

list-reminder

crm pw-step list-reminder
  step_id
  [--offset]
  [--count]

1. step_id
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

set-state

crm pw-step set-state
  step_id
  state

1. step_id
2. state
   Valid values:  new, incomplete, inprogress, inreview, skipped, complete, archived
   

update

crm pw-step update
  step_id
  [--args]
  [--description]
  [--due-date]
  [--generate-event]
  [--no-generate-event]
  [--group-id]
  [--order]
  [--title]
  [--user-id]

1. step_id
2. --args Optional.
3. --description Optional.
4. --due-date Optional.
5. --generate-event Optional.
6. --no-generate-event Optional.
7. --group-id Optional.
8. --order Optional.
9. --title Optional.
10. --user-id Optional.

trigger-reminder

crm pw-step trigger-reminder
  step_id
  reminder

1. step_id
2. reminder

---

py-cerner

Pylon EHR Cerner commands
Sub commands: list-cred

list-cred

crm py-cerner list-cred
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, organization-id
   

   Valid values:  id, name, organization-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

---

py-elation

Pylon EHR Elation commands
Sub commands: list-cred

list-cred

crm py-elation list-cred
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, organization-id
   

   Valid values:  id, name, organization-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

---

py-epic

Pylon EHR EPIC commands
Sub commands: list-account

list-account

crm py-epic list-account
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, organization-id
   

   Valid values:  id, name, organization-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

---

py-jobexec

Job Executor Configuration commands
Sub commands: create, delete, get, list, update

create

crm py-jobexec create
  name
  [--organization]
  [--wait]
  [--memory-size]
  [--runtime-version]

1. name
   Executor name.
2. --organization Optional.
   Organization ID if different from default.
3. --wait Optional.
4. --memory-size Optional.
   Memory size in MB.
5. --runtime-version Optional.
   Lambda Runtime version (eg 1.2.3, $STABLE, or $LATEST).

delete

crm py-jobexec delete
  executor_id

1. executor_id

get

crm py-jobexec get
  executor_id

1. executor_id

list

crm py-jobexec list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, memory-size, runtime-version, status
   

   Valid values:  created-at, created-by, id, last-updated-at, last-updated-by, memory-size, name, runtime-version, status
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm py-jobexec update
  executor_id
  [--wait]
  [--memory-size]
  [--runtime-version]

1. executor_id
2. --wait Optional.
3. --memory-size Optional.
   Memory size in MB.
4. --runtime-version Optional.
   Lambda Runtime version (eg 1.2.3, $STABLE, or $LATEST).

---

py-jobsecret

Job Secret commands
Sub commands: create, delete, get-value, list, update

create

crm py-jobsecret create
  name
  [--type]
  [--json-value]

1. name
   Unique name for the secret.
2. --type Optional.
   Default:  json
   

   Valid values:  json
   
3. --json-value Optional.

delete

crm py-jobsecret delete
  secret_id

1. secret_id

list

crm py-jobsecret list
  [--fields]

1. --fields Optional.
   Default:  id, name, type, modified-at
   

   Valid values:  created-at, created-by, global, id, modified-at, modified-by, name, organization, type
   

update

crm py-jobsecret update
  secret_id
  [--json-value]

1. secret_id
2. --json-value Optional.

get-value

crm py-jobsecret get-value
  secret_id

1. secret_id

---

py-jobspec

Job Spec commands
Sub commands: add-secret, create, create-module, create-queue, create-queue-entry, delete, delete-queue, delete-storage, get, get-queue, get-storage, list, list-queue, list-queue-entry, list-storage, log, remove-secret, run, set-default, update

add-secret

crm py-jobspec add-secret
  spec_id
  key
  [--secret-name]

1. spec_id
2. key
   Arbitrary key to bind the secret value to.
3. --secret-name Optional.
   Name of the secret.

create

crm py-jobspec create
  object
  event
  code
  class_name
  [--executor]
  [--name]

1. object
2. event
3. code
4. class_name
5. --executor Optional.
6. --name Optional.

create-module

crm py-jobspec create-module
  name
  code
  [--global]
  [--description]

1. name
2. code
3. --global Optional.
4. --description Optional.

create-queue

crm py-jobspec create-queue
  spec_id
  name
  [--worker-count]

1. spec_id
2. name
3. --worker-count Optional.
   Default:  1
   

create-queue-entry

crm py-jobspec create-queue-entry
  queue_id
  data

1. queue_id
2. data

delete

crm py-jobspec delete
  spec_id

1. spec_id

delete-queue

crm py-jobspec delete-queue
  queue_id

1. queue_id

delete-storage

crm py-jobspec delete-storage
  storage_id

1. storage_id

get

crm py-jobspec get
  spec_id
  [--args]
  [--code]
  [--schema]

1. spec_id
2. --args Optional.
3. --code Optional.
4. --schema Optional.

get-queue

crm py-jobspec get-queue
  queue_id

1. queue_id

get-storage

crm py-jobspec get-storage
  storage_id

1. storage_id

list

crm py-jobspec list
  [--executor]
  [--fields]
  [--refcode]
  [--offset]
  [--count]

1. --executor Optional.
2. --fields Optional.
   Default:  id, object, event, name, count-trigger, count-filter
   

   Valid values:  args, class, container, count-filter, count-trigger, created-at, created-by, differences, event, executor-id, executor-name, filter, id, modified-at, modified-by, monitored, name, object, run-as, schedule-id, schedule-rrule, schedule-start, schedule-timezone, secret-bindings
   
3. --refcode Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

list-queue

crm py-jobspec list-queue
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, spec-id, worker, entries
   

   Valid values:  entries, id, name, spec-id, worker
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-queue-entry

crm py-jobspec list-queue-entry
  queue_id
  [--offset]
  [--count]

1. queue_id
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-storage

crm py-jobspec list-storage
  spec_id
  [--fields]
  [--offset]
  [--count]

1. spec_id
2. --fields Optional.
   Default:  id, index, created-at, value
   

   Valid values:  created-at, id, index, modified-at, value
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm py-jobspec log
  spec_id
  [log_id]
  [--offset]
  [--filter]
  [--count]
  [--last]
  [--input]
  [--status]
  [--wait]
  [-f/--follow]

1. spec_id
2. log_id Optional.
3. --offset Optional.
   Paging offset.
4. --filter Optional.
5. --count Optional.
   Default:  10
   
6. --last Optional.
7. --input Optional.
8. --status Optional.
   Valid values:  dropped-dup, dropped-filter, dropped-rate, debounced, failed, running, started, success
   
9. --wait Optional.
10. -f/--follow Optional.

remove-secret

crm py-jobspec remove-secret
  spec_id
  key

1. spec_id
2. key
   Key to unbind.

run

crm py-jobspec run
  spec_id
  data
  [--wait]

1. spec_id
2. data
   JSON, log-id, or log~N to use last-log's input.
3. --wait Optional.

set-default

crm py-jobspec set-default
  spec_id

1. spec_id

update

crm py-jobspec update
  spec_id
  [--allow-continuation]
  [--allow-participant]
  [--args]
  [--args-schema]
  [--class]
  [--code]
  [--consecutive-threshold]
  [--event]
  [--executor]
  [--filter]
  [--log-level]
  [--log-limit]
  [--monitored]
  [--not-allow-continuation]
  [--not-allow-participant]
  [--not-monitored]
  [--name]
  [--object]
  [--run-as]
  [--runs-per-minute]
  [--schedule-rrule]
  [--schedule-start]
  [--schedule-timezone]
  [--schema]
  [--ui-args-schema]

1. spec_id
2. --allow-continuation Optional.
3. --allow-participant Optional.
4. --args Optional.
5. --args-schema Optional.
6. --class Optional.
7. --code Optional.
8. --consecutive-threshold Optional.
9. --event Optional.
10. --executor Optional.
    Executor ID.
11. --filter Optional.
12. --log-level Optional.
    Valid values:  debug, info, warning, error, critical
    
13. --log-limit Optional.
14. --monitored Optional.
15. --not-allow-continuation Optional.
16. --not-allow-participant Optional.
17. --not-monitored Optional.
18. --name Optional.
19. --object Optional.
20. --run-as Optional.
21. --runs-per-minute Optional.
22. --schedule-rrule Optional.
23. --schedule-start Optional.
24. --schedule-timezone Optional.
25. --schema Optional.
26. --ui-args-schema Optional.

---

py-module

Job Module commands
Sub commands: create, create-version, delete, get, get-version, list, update, update-version

create

crm py-module create
  name
  code
  [--global]
  [--description]

1. name
2. code
3. --global Optional.
4. --description Optional.

create-version

crm py-module create-version
  module_id
  name
  code
  [--description]

1. module_id
2. name
3. code
4. --description Optional.

delete

crm py-module delete
  module_id

1. module_id

get

crm py-module get
  module_id
  [--code]

1. module_id
2. --code Optional.

get-version

crm py-module get-version
  version_id
  [--code]

1. version_id
2. --code Optional.

list

crm py-module list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, modified-at, version, global
   

   Valid values:  created-at, description, global, id, modified-at, name, version
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm py-module update
  module_id
  [--description]
  [--version]
  [--name]

1. module_id
2. --description Optional.
3. --version Optional.
4. --name Optional.

update-version

crm py-module update-version
  version_id
  [--code]
  [--description]
  [--name]

1. version_id
2. --code Optional.
3. --description Optional.
4. --name Optional.

---

py-repo

Pylon repository management
Sub commands: create, delete, list, update

create

crm py-repo create
  name
  key
  url
  [--global]

1. name
2. key
3. url
4. --global Optional.

delete

crm py-repo delete
  repo_id

1. repo_id

list

crm py-repo list
  [--fields]

1. --fields Optional.
   Default:  id, name, url, global
   

   Valid values:  created-at, global, id, modified-at, name, url
   

update

crm py-repo update
  repo_id
  [--key]
  [--url]

1. repo_id
2. --key Optional.
3. --url Optional.

---

py-s3-event

Pylon S3 event commands
Sub commands: list-files, list-maps

list-maps

crm py-s3-event list-maps
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, key-prefix, bucket-name, created-at
   

   Valid values:  bucket-name, created-at, id, key-prefix
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

list-files

crm py-s3-event list-files
  map_id
  [--fields]
  [--offset]
  [--count]

1. map_id
2. --fields Optional.
   Default:  id, filename, created-at
   

   Valid values:  created-at, filename, id
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

---

py-setting

Pylon setting commands
Sub commands: create, delete, get, list, update

create

crm py-setting create
  name
  value

1. name
2. value

delete

crm py-setting delete
  setting_id

1. setting_id

get

crm py-setting get
  setting_id

1. setting_id

list

crm py-setting list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, modified-at, name, value
   

   Valid values:  created-at, id, modified-at, name, value
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm py-setting update
  setting_id
  [--value]

1. setting_id
2. --value Optional.

---

py-sftp-remote

Pylon SFTP remote server management
Sub commands: cli, create, delete, get, list, list-put, put, update

create

crm py-sftp-remote create
  name
  username
  host
  [--port]
  [--password]

1. name
2. username
3. host
4. --port Optional.
5. --password Optional.

delete

crm py-sftp-remote delete
  remote_id

1. remote_id

get

crm py-sftp-remote get
  remote_id
  [--public-key]

1. remote_id
2. --public-key Optional.

list

crm py-sftp-remote list
  [--name]
  [--fields]
  [--offset]
  [--count]

1. --name Optional.
2. --fields Optional.
   Default:  id, name, host, username
   

   Valid values:  host, id, name, username
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm py-sftp-remote update
  remote_id
  [--username]
  [--host]
  [--port]
  [--password]
  [--no-password]

1. remote_id
2. --username Optional.
3. --host Optional.
4. --port Optional.
5. --password Optional.
6. --no-password Optional.

cli

crm py-sftp-remote cli
  remote_id
  command

1. remote_id
2. command
   Valid values:  ls
   

put

crm py-sftp-remote put
  remote_id
  source_filepath
  remote_filepath
  [--content-type]

1. remote_id
2. source_filepath
3. remote_filepath
4. --content-type Optional.

list-put

crm py-sftp-remote list-put
  remote_id
  [--fields]
  [--offset]
  [--count]

1. remote_id
2. --fields Optional.
   Default:  id, source, target, status
   

   Valid values:  content-type, id, source, status, target
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

---

py-sftp-user

Pylon SFTP user management
Sub commands: add-key, create, delete, get, list, remove-key

add-key

crm py-sftp-user add-key
  user_id
  public_key

1. user_id
   SFTP user id.
2. public_key
   Public key to upload.

create

crm py-sftp-user create
  username
  [--org]

1. username
2. --org Optional.
   Organization owning SFTP user. Default: active organization.

delete

crm py-sftp-user delete
  user_id

1. user_id
   SFTP user id.

get

crm py-sftp-user get
  user_id

1. user_id
   SFTP user id.

list

crm py-sftp-user list
  [--username]
  [--fields]

1. --username Optional.
2. --fields Optional.
   Default:  id, username, organization-id, key-count
   

   Valid values:  id, key-count, keys, organization-id, username
   

remove-key

crm py-sftp-user remove-key
  user_id
  key_id

1. user_id
   SFTP user id.
2. key_id
   ID of SFTP Key to delete.

---

py-vcs

Pylon repository management
Sub commands: create, delete, get, list, sync, update, update-status

create

crm py-vcs create
  spec_id
  repo_id
  path
  [--branch]

1. spec_id
2. repo_id
3. path
4. --branch Optional.
   Default:  master
   

delete

crm py-vcs delete
  vcs_id

1. vcs_id

get

crm py-vcs get
  vcs_id

1. vcs_id

list

crm py-vcs list
  [--fields]

1. --fields Optional.
   Default:  id, spec-name, repository-name, path, is-dirty
   

   Valid values:  branch, created-at, id, is-dirty, modified-at, path, repository-id, repository-name, spec-id, spec-name
   

sync

crm py-vcs sync
  vcs_id

1. vcs_id

update

crm py-vcs update
  vcs_id
  [--branch]
  [--path]

1. vcs_id
2. --branch Optional.
3. --path Optional.

update-status

crm py-vcs update-status

---

shell

Enter IPython REPL with brewmaster initialized

---

sw-banner

Banner commands
Sub commands: create, delete, get, list, update

create

crm sw-banner create
  name
  type
  message_en
  message_es
  [--args]
  [--description]

1. name
2. type
   Valid values:  survey, upgrade
   
3. message_en
4. message_es
5. --args Optional.
6. --description Optional.

delete

crm sw-banner delete
  banner_id

1. banner_id

get

crm sw-banner get
  banner_id

1. banner_id

list

crm sw-banner list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, type, description, message
   

   Valid values:  args, description, id, message, messages, name, type
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm sw-banner update
  banner_id
  [--args]
  [--description]
  [--message-en]
  [--message-es]
  [--name]

1. banner_id
2. --args Optional.
3. --description Optional.
4. --message-en Optional.
5. --message-es Optional.
6. --name Optional.

---

sw-company

Company Commands
Sub commands: create, delete, list, update

create

crm sw-company create
  name
  app_display_name
  display_name
  care_app_display_name
  [--app-url-android]
  [--app-url-ios]
  [--care-app-url-android]
  [--care-app-url-ios]
  [--default-organization-code]
  [--fqdn]
  [--support-email]

1. name
2. app_display_name
3. display_name
4. care_app_display_name
5. --app-url-android Optional.
6. --app-url-ios Optional.
7. --care-app-url-android Optional.
8. --care-app-url-ios Optional.
9. --default-organization-code Optional.
10. --fqdn Optional.
11. --support-email Optional.

list

crm sw-company list
  [--fields]
  [--name]
  [--fqdn]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  fqdn, name, app-url-android, app-url-ios, support-email
   

   Valid values:  app-display-name, app-url-android, app-url-ios, care-app-display-name, care-app-url-android, care-app-url-ios, default-organization-code, display-name, fqdn, id, name, support-email
   
2. --name Optional.
3. --fqdn Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm sw-company update
  company_id
  [--app-url-android]
  [--app-url-ios]
  [--care-app-url-android]
  [--care-app-url-ios]
  [--default-organization-code]
  [--fqdn]
  [--support-email]

1. company_id
2. --app-url-android Optional.
3. --app-url-ios Optional.
4. --care-app-url-android Optional.
5. --care-app-url-ios Optional.
6. --default-organization-code Optional.
7. --fqdn Optional.
8. --support-email Optional.

delete

crm sw-company delete
  company_id

1. company_id

---

sw-debugger

Debugger commands
Sub commands: create, delete, list, log

create

crm sw-debugger create
  individual_id

1. individual_id

delete

crm sw-debugger delete
  debugger_id

1. debugger_id

list

crm sw-debugger list
  [--fields]
  [--individual]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, created-at, individual-id, scopes
   

   Valid values:  created-at, id, individual-id, scopes
   
2. --individual Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm sw-debugger log
  debugger_id
  [--offset]
  [--count]
  [--colsize]
  [--fields]

1. debugger_id
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   
4. --colsize Optional.
   Default:  100
   
5. --fields Optional.
   Default:  created-at, message
   

   Valid values:  created-at, id, message
   

---

sw-helpdoc

Help Docs commands
Sub commands: create

create

crm sw-helpdoc create
  name
  url
  [--org]
  [--locale]
  [--doc-type]
  [--order]

1. name
2. url
3. --org Optional.
4. --locale Optional.
   Default:  en_US
   

   Valid values:  en_US, es_US
   
5. --doc-type Optional.
   Valid values:  participant, provider
   
6. --order Optional.

---

sw-landingpage

Landing Page
Sub commands: create, delete, list, upload-image

create

crm sw-landingpage create
  company_name
  name
  order
  [--details-en]
  [--details-es]
  [--min-android-version]
  [--min-ios-version]
  [--titles-en]
  [--titles-es]

1. company_name
2. name
3. order
4. --details-en Optional.
5. --details-es Optional.
6. --min-android-version Optional.
7. --min-ios-version Optional.
8. --titles-en Optional.
9. --titles-es Optional.

upload-image

crm sw-landingpage upload-image
  id
  file
  [--offset]
  [--count]

1. id
2. file
   Path to file name.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

list

crm sw-landingpage list
  [--fields]
  [--name]
  [--company-name]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  company-name, details-en, details-es, id, name, order
   

   Valid values:  company-name, details-en, details-es, id, min-android-version, min-ios-version, name, order, titles-en, titles-es
   
2. --name Optional.
3. --company-name Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

delete

crm sw-landingpage delete
  id

1. id

---

sw-logo

Private label logo commands
Sub commands: create, delete, list

create

Upload new or replace an existing logo

crm sw-logo create
  fqdn
  type
  filename

1. fqdn
   Private label fully-qualified domain name.
2. type
   Logo type to upload (LOGO_SIGN_IN, LOGO, FAVICON_32, ...).
3. filename
   Path to logo file to upload.

delete

crm sw-logo delete
  logo_id

1. logo_id

list

crm sw-logo list
  [--fields]
  [--fqdn]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  fqdn, id, active, type, image-url
   

   Valid values:  active, fqdn, id, image-url, type
   
2. --fqdn Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

---

sw-patient

Patient commands
Sub commands: create, list

create

crm sw-patient create
  email
  birth_date
  first_name
  last_name
  [--gender]
  [--locale]
  [--group]

1. email
2. birth_date
3. first_name
4. last_name
5. --gender Optional.
   Default:  pnta
   

   Valid values:  male, female, pnta, unknown, other
   
6. --locale Optional.
   Default:  en_US
   

   Valid values:  en_US, es_US
   
7. --group Optional.

list

crm sw-patient list
  [--birth-date]
  [--fields]
  [--first-name]
  [--last-name]
  [--unverified]
  [--offset]
  [--count]

1. --birth-date Optional.
2. --fields Optional.
   Default:  id, email
   

   Valid values:  email, first-name, id, last-name, user-id, verified
   
3. --first-name Optional.
4. --last-name Optional.
5. --unverified Optional.
6. --offset Optional.
   Paging offset.
7. --count Optional.
   Number of items to return.

   Default:  50
   

---

sw-provider

Provider commands
Sub commands: create

create

crm sw-provider create
  email
  first_name
  last_name
  [--locale]
  [--admin]
  [--organization]

1. email
2. first_name
3. last_name
4. --locale Optional.
   Default:  en_US
   

   Valid values:  en_US, es_US
   
5. --admin Optional.
6. --organization Optional.

---

version

Show version information

---

wf-config

Workflow program config
Sub commands: create, delete, get, list, update, update-args

create

crm wf-config create
  name
  [--args]

1. name
2. --args Optional.

delete

crm wf-config delete
  config_id

1. config_id

get

crm wf-config get
  config_id

1. config_id

list

crm wf-config list
  [--fields]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, created-at, args
   

   Valid values:  args, created-at, created-by, id, modified-at, modified-by, name, new-user
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm wf-config update
  config_id
  [--args]

1. config_id
2. --args Optional.

update-args

crm wf-config update-args
  config_id
  [--rpm-billing]
  [--no-rpm-billing]
  [--ccm-billing]
  [--no-ccm-billing]
  [--add-email-id]
  [--remove-email-id]
  [--todo-group-id]
  [--disable-flag]
  [--enable-flag]

1. config_id
2. --rpm-billing Optional.
3. --no-rpm-billing Optional.
4. --ccm-billing Optional.
5. --no-ccm-billing Optional.
6. --add-email-id Optional.
7. --remove-email-id Optional.
8. --todo-group-id Optional.
9. --disable-flag Optional.
10. --enable-flag Optional.

---

wf-instance

Workflow instance management
Sub commands: create, delete, get, get-stats, list, log, set-default

create

crm wf-instance create
  type_id
  individual_id
  [--version]
  [--user-metadata]
  [--interaction-args]
  [--sim-args]

1. type_id
2. individual_id
3. --version Optional.
4. --user-metadata Optional.
5. --interaction-args Optional.
6. --sim-args Optional.

delete

crm wf-instance delete
  workflow_id

1. workflow_id

get

crm wf-instance get
  workflow_id

1. workflow_id

get-stats

crm wf-instance get-stats
  workflow_id

1. workflow_id

list

crm wf-instance list
  [--fields]
  [--individual]
  [--workflow-name]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, type-name, created-at, individual-id
   

   Valid values:  active, created-at, created-by, id, individual-id, interaction-args, modified-at, state, state-data, stats, type-id, type-name, user-metadata, version
   
2. --individual Optional.
3. --workflow-name Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm wf-instance log
  workflow_id
  [-f/--follow]
  [--with-data]
  [--level]
  [--count]

1. workflow_id
2. -f/--follow Optional.
3. --with-data Optional.
4. --level Optional.
   Default:  DEBUG
   

   Valid values:  DEBUG, INFO, WARN, ERROR, CRIT
   
5. --count Optional.
   Number of items to return.

   Default:  50
   

set-default

crm wf-instance set-default
  workflow_id

1. workflow_id

---

wf-interaction

Workflow interaction management
Sub commands: delete, event, get, list, log

delete

crm wf-interaction delete
  interaction_id

1. interaction_id

event

crm wf-interaction event
  interaction_id
  invocation_id
  [--data]

1. interaction_id
2. invocation_id
3. --data Optional.

get

crm wf-interaction get
  interaction_id

1. interaction_id

list

crm wf-interaction list
  [--fields]
  [--offset]
  [--count]
  [--profile]
  [--individual]
  [--workflow]
  [--inactive]

1. --fields Optional.
   Default:  id, profile, version, created-at, individual-id
   

   Valid values:  active, args, created-at, created-by, id, individual-id, profile, profile-id, user-id, version, workflow-id
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   
4. --profile Optional.
5. --individual Optional.
6. --workflow Optional.
7. --inactive Optional.

log

crm wf-interaction log
  interaction_id
  [-f/--follow]
  [--with-data]
  [--count]
  [--level]

1. interaction_id
2. -f/--follow Optional.
3. --with-data Optional.
4. --count Optional.
   Default:  20
   
5. --level Optional.
   Default:  DEBUG
   

   Valid values:  DEBUG, INFO, WARN, ERROR, CRIT
   

---

wf-lnp

LNP management
Sub commands: delete, get, get-run, list, list-run, update

delete

crm wf-lnp delete
  program

1. program

get

crm wf-lnp get
  program

1. program

get-run

crm wf-lnp get-run
  run

1. run

list

crm wf-lnp list
  [--fields]
  [--offset]
  [--count]
  [--name]

1. --fields Optional.
   Default:  id, name, created-at, armed, event-type
   

   Valid values:  active-version, armed, created-at, created-by, description, event-type, id, modified-at, modified-by, name, run-as
   
2. --offset Optional.
   Paging offset.
3. --count Optional.
   Number of items to return.

   Default:  50
   
4. --name Optional.

list-run

crm wf-lnp list-run
  program
  [--fields]
  [--offset]
  [--count]

1. program
2. --fields Optional.
   Default:  id, created-at, status
   

   Valid values:  created-at, error, id, modified-at, status
   
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

update

crm wf-lnp update
  program
  [--arm]
  [--disarm]
  [--description]
  [--event-filter]
  [--event-type]

1. program
2. --arm Optional.
3. --disarm Optional.
4. --description Optional.
5. --event-filter Optional.
6. --event-type Optional.

---

wf-profile

Workflow profile management
Sub commands: add-version, delete, find-versions, get, list, set-default

add-version

crm wf-profile add-version
  profile_id
  spec
  [--name]

1. profile_id
2. spec
3. --name Optional.

delete

crm wf-profile delete
  profile_id

1. profile_id

find-versions

crm wf-profile find-versions
  spec

1. spec

get

crm wf-profile get
  profile_id
  [--version]

1. profile_id
2. --version Optional.

list

crm wf-profile list
  [--fields]
  [--name]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, default-version, default-version-hash, created-at
   

   Valid values:  active, created-at, created-by, created-by-id, default-version, default-version-hash, id, modified-at, modified-by, modified-by-id, name, organization-id
   
2. --name Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

set-default

crm wf-profile set-default
  profile_id

1. profile_id

---

wf-program

Workflow program
Sub commands: create, delete, get, list, list-args, list-args-history, log, start, stop, update, update-args

create

crm wf-program create
  name
  individual_id
  [--auto-start]
  [--args]

1. name
2. individual_id
3. --auto-start Optional.
4. --args Optional.

delete

crm wf-program delete
  program_id

1. program_id

get

crm wf-program get
  program_id
  [--args]

1. program_id
2. --args Optional.

list

crm wf-program list
  [--fields]
  [--individual]
  [--name]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, individual-id, state
   

   Valid values:  args, created-at, derived-args, id, individual-id, modified-at, name, state, storage
   
2. --individual Optional.
3. --name Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

list-args

crm wf-program list-args
  [--fields]
  [--individual]
  [--name]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, derived-args, billing-eligible, ccm-billing-eligible, num-of-emails
   

   Valid values:  billing-eligible, ccm-billing-eligible, created-at, derived-args, email-individual-ids, id, individual-id, num-of-emails, state, todo-group-id
   
2. --individual Optional.
3. --name Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

list-args-history

crm wf-program list-args-history
  program_id
  [log_id]
  [--offset]
  [--count]

1. program_id
2. log_id Optional.
3. --offset Optional.
   Paging offset.
4. --count Optional.
   Number of items to return.

   Default:  50
   

log

crm wf-program log
  program_id
  [log_id]
  [--colsize]
  [--fields]
  [--offset]
  [--count]

1. program_id
2. log_id Optional.
3. --colsize Optional.
   Default:  30
   
4. --fields Optional.
   Default:  id, created-at, level, message
   

   Valid values:  created-at, data, id, level, message
   
5. --offset Optional.
   Paging offset.
6. --count Optional.
   Number of items to return.

   Default:  50
   

start

crm wf-program start
  program_id

1. program_id

stop

crm wf-program stop
  program_id

1. program_id

update

crm wf-program update
  program_id
  [--args]

1. program_id
2. --args Optional.

update-args

crm wf-program update-args
  program_id
  [--rpm-billing]
  [--no-rpm-billing]
  [--ccm-billing]
  [--no-ccm-billing]
  [--add-email-id]
  [--remove-email-id]
  [--todo-group-id]
  [--disable-flag]
  [--enable-flag]

1. program_id
2. --rpm-billing Optional.
3. --no-rpm-billing Optional.
4. --ccm-billing Optional.
5. --no-ccm-billing Optional.
6. --add-email-id Optional.
7. --remove-email-id Optional.
8. --todo-group-id Optional.
9. --disable-flag Optional.
10. --enable-flag Optional.

---

wf-type

Workflow-type management
Sub commands: create, delete, diff, get, list, set-default, update

create

crm wf-type create
  name
  category
  [--type]
  [--supports-unverified-users]

1. name
2. category
3. --type Optional.
4. --supports-unverified-users Optional.

delete

crm wf-type delete
  type_id

1. type_id

diff

crm wf-type diff
  type_id
  [--detail]

1. type_id
2. --detail Optional.
   Default:  none
   

   Valid values:  none, partial, full
   

get

crm wf-type get
  type_id
  [--version]

1. type_id
2. --version Optional.

list

crm wf-type list
  [--fields]
  [--name]
  [--type]
  [--offset]
  [--count]

1. --fields Optional.
   Default:  id, name, type, category, select-version, select-hash
   

   Valid values:  active, category, created-at, created-by, id, latest-detail, latest-hash, latest-version, modified-at, modified-by, name, select-detail, select-hash, select-version, support-unverified, type
   
2. --name Optional.
3. --type Optional.
4. --offset Optional.
   Paging offset.
5. --count Optional.
   Number of items to return.

   Default:  50
   

set-default

crm wf-type set-default
  type_id

1. type_id

update

crm wf-type update
  type_id
  [--supports-unverified-users/-s]
  [--no-supports-unverified-users/-u]

1. type_id
2. --supports-unverified-users/-s Optional.
3. --no-supports-unverified-users/-u Optional.

---

whoami

Show current user information