Command Line Tools for the Parsable PaaS
Minimum NodeJS version >= 12.0.0
$ npm install -g @wearableintelligence/parsable-cli
$ parsable-cli COMMAND
running command...
$ parsable-cli (-v|--version|version)
@wearableintelligence/parsable-cli/1.2.0 darwin-x64 node-v16.13.1
$ parsable-cli --help [COMMAND]
USAGE
$ parsable-cli COMMAND
...
parsable-cli analytics:feed:access:check
parsable-cli analytics:feed:access:disable
parsable-cli analytics:feed:access:enable
parsable-cli analytics:feed:cluster:delete
parsable-cli analytics:feed:cluster:external:create
parsable-cli analytics:feed:cluster:get
parsable-cli analytics:feed:cluster:get-one
parsable-cli analytics:feed:cluster:internal:create
parsable-cli analytics:feed:credential:delete
parsable-cli analytics:feed:credential:external:create
parsable-cli analytics:feed:credential:get
parsable-cli analytics:feed:credential:get-one
parsable-cli analytics:feed:credential:internal:create
parsable-cli analytics:feed:jdbc-sas-credential:delete
parsable-cli analytics:feed:jdbc-sas-credential:external:create
parsable-cli analytics:feed:jdbc-sas-credential:get
parsable-cli analytics:feed:jdbc-sas-credential:get-one
parsable-cli analytics:feed:jdbc-sas-credential:internal:create
parsable-cli analytics:feed:jdbc-sink:delete
parsable-cli analytics:feed:jdbc-sink:external:create
parsable-cli analytics:feed:jdbc-sink:get
parsable-cli analytics:feed:jdbc-sink:get-one
parsable-cli analytics:feed:jdbc-sink:internal:create
parsable-cli analytics:feed:jdbc-sink:start
parsable-cli analytics:feed:jdbc-sink:stop
parsable-cli analytics:feed:sas-credential:delete
parsable-cli analytics:feed:sas-credential:external:create
parsable-cli analytics:feed:sas-credential:get
parsable-cli analytics:feed:sas-credential:get-one
parsable-cli analytics:feed:sas-credential:internal:create
parsable-cli analytics:feed:schema-registry:credential:delete
parsable-cli analytics:feed:schema-registry:credential:external:create
parsable-cli analytics:feed:schema-registry:credential:get
parsable-cli analytics:feed:schema-registry:credential:internal:create
parsable-cli analytics:feed:schema-registry:credential:list
parsable-cli analytics:feed:topic:consume
parsable-cli analytics:feed:topic:delete
parsable-cli analytics:feed:topic:external:create
parsable-cli analytics:feed:topic:get
parsable-cli analytics:feed:topic:get-one
parsable-cli analytics:feed:topic:internal:create
parsable-cli analytics:feed:topic:start
parsable-cli analytics:feed:topic:stop
parsable-cli analytics:report:group:add
parsable-cli analytics:report:group:available
parsable-cli analytics:report:group:delete
parsable-cli analytics:report:group:get
parsable-cli analytics:report:group:list
parsable-cli analytics:report:group:remove
parsable-cli analytics:report:group:set
parsable-cli analytics:report:manage:creation:disable
parsable-cli analytics:report:manage:creation:enable
parsable-cli analytics:report:manage:creation:get
parsable-cli analytics:report:quantified-users:delete
parsable-cli analytics:report:quantified-users:enable MODE
parsable-cli analytics:report:quantified-users:get
parsable-cli analytics:report:quantified-users:set
parsable-cli analytics:report:retention:get
parsable-cli analytics:report:retention:set TTL [UNIT]
parsable-cli analytics:report:upload:external:delete
parsable-cli analytics:report:upload:external:enable MODE
parsable-cli analytics:report:upload:external:get
parsable-cli analytics:report:upload:external:set
parsable-cli analytics:report:upload:external:test
parsable-cli analytics:report:upload:internal:delete
parsable-cli analytics:report:upload:internal:enable MODE
parsable-cli analytics:report:upload:internal:get
parsable-cli analytics:report:upload:internal:set
parsable-cli analytics:report:upload:internal:test
parsable-cli attributes:add
parsable-cli attributes:list
parsable-cli attributes:remove
parsable-cli exec-data:delete
parsable-cli help [COMMAND]
parsable-cli jobs:create
parsable-cli jobs:delete
parsable-cli login
parsable-cli login-mothership
parsable-cli me
parsable-cli params:add
parsable-cli params:list
parsable-cli params:update
parsable-cli policies:add
parsable-cli policies:list
parsable-cli settings:audit
parsable-cli settings:list
parsable-cli settings:update
parsable-cli settings:versions
parsable-cli teams:create
parsable-cli teams:delete
parsable-cli teams:disable
parsable-cli teams:enable
parsable-cli teams:fetch
parsable-cli teams:list
parsable-cli teams:provision-trial
parsable-cli teams:update
parsable-cli template:copy
parsable-cli template:copy:status
parsable-cli update [CHANNEL]
parsable-cli users:add
parsable-cli users:apply
parsable-cli users:assign
parsable-cli users:bulk:update
parsable-cli users:delete
parsable-cli users:grant
parsable-cli users:list
parsable-cli users:query
parsable-cli users:remove
parsable-cli users:revoke
parsable-cli users:show
parsable-cli users:tokens
parsable-cli users:unapply
parsable-cli users:unassign
parsable-cli users:update
Check access to data feed
USAGE
$ parsable-cli analytics:feed:access:check
OPTIONS
-c, --cluster=cluster Cluster name
-j, --jdbc JDBC sink
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Check access to data feed by Team ID or Subdomain and cluster or JDBC sink.
EXAMPLES
parsable-cli analytics:feed:access:check
parsable-cli analytics:feed:access:check -c cluster-name
parsable-cli analytics:feed:access:check -j
parsable-cli analytics:feed:access:check -t best-team
parsable-cli analytics:feed:access:check -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Disable access to data feed
USAGE
$ parsable-cli analytics:feed:access:disable
OPTIONS
-c, --cluster=cluster Cluster name
-j, --jdbc JDBC sink
-s, --sync Wait for access to fully disable
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Disable access to data feed by Team ID or Subdomain and cluster or JDBC sink.
EXAMPLES
parsable-cli analytics:feed:access:disable
parsable-cli analytics:feed:access:disable -s
parsable-cli analytics:feed:access:disable -c cluster-name
parsable-cli analytics:feed:access:disable -j
parsable-cli analytics:feed:access:disable -t best-team
parsable-cli analytics:feed:access:disable -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Enable access to data feed
USAGE
$ parsable-cli analytics:feed:access:enable
OPTIONS
-c, --cluster=cluster Cluster name
-j, --jdbc JDBC sink
-s, --sync Wait for access to fully enable
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Enable access to data feed by Team ID or Subdomain and cluster or JDBC sink.
EXAMPLES
parsable-cli analytics:feed:access:enable
parsable-cli analytics:feed:access:enable -s
parsable-cli analytics:feed:access:enable -c cluster-name
parsable-cli analytics:feed:access:enable -j
parsable-cli analytics:feed:access:enable -t best-team
parsable-cli analytics:feed:access:enable -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Delete cluster for analytics feed
USAGE
$ parsable-cli analytics:feed:cluster:delete
OPTIONS
-c, --cluster=cluster (required) Cluster name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete cluster for analytics feed by its name and Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:cluster:delete -c cluster-name
parsable-cli analytics:feed:cluster:delete -c cluster-name -t best-team
parsable-cli analytics:feed:cluster:delete -c cluster-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create external cluster for analytics feed
USAGE
$ parsable-cli analytics:feed:cluster:external:create
OPTIONS
-s, --sync Wait for cluster to fully create
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an external cluster for analytics feed for certain team by Team ID or Subdomain
EXAMPLES
parsable-cli analytics:feed:cluster:external:create
parsable-cli analytics:feed:cluster:external:create -s
parsable-cli analytics:feed:cluster:external:create -t best-team
parsable-cli analytics:feed:cluster:external:create -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch list of clusters for analytics feed
USAGE
$ parsable-cli analytics:feed:cluster:get
OPTIONS
-a, --all Request all available clusters for all teams.
-t, --teamId=teamId Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch list of clusters by Team ID or Subdomain.
Or fetch all clusters for all teams. Last action requires a super admin role.
ALIASES
$ parsable-cli analytics:feed:cluster:get
$ parsable-cli analytics:feed:cluster:show
$ parsable-cli analytics:feed:cluster:info
EXAMPLES
parsable-cli analytics:feed:cluster:get
parsable-cli analytics:feed:cluster:get -a
parsable-cli analytics:feed:cluster:get -t best-team
parsable-cli analytics:feed:cluster:show -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch one cluster for analytics feed
USAGE
$ parsable-cli analytics:feed:cluster:get-one
OPTIONS
-c, --cluster=cluster (required) Cluster name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Fetch one cluster for analytics feed by its name and Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:cluster:get-one
$ parsable-cli analytics:feed:cluster:show-one
$ parsable-cli analytics:feed:cluster:info-one
EXAMPLES
parsable-cli analytics:feed:cluster:get-one -c cluster-name
parsable-cli analytics:feed:cluster:get-one -c cluster-name -t best-team
parsable-cli analytics:feed:cluster:show-one -c cluster-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create internal cluster for analytics feed
USAGE
$ parsable-cli analytics:feed:cluster:internal:create
OPTIONS
-s, --sync Wait for cluster to fully create
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an internal cluster for analytics feed for certain team by Team ID or Subdomain
EXAMPLES
parsable-cli analytics:feed:cluster:internal:create
parsable-cli analytics:feed:cluster:internal:create -s
parsable-cli analytics:feed:cluster:internal:create -t best-team
parsable-cli analytics:feed:cluster:internal:create -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Delete credential for topic in analytics feed
USAGE
$ parsable-cli analytics:feed:credential:delete
OPTIONS
-c, --cluster=cluster [default: default] Cluster name
-i, --id=id (required) Credential id
-n, --name=name (required) Topic name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete credential for topic in analytics feed by its id, topic, cluster and Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:credential:delete -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e
parsable-cli analytics:feed:credential:delete -c cluster-name -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e
parsable-cli analytics:feed:credential:delete -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e -t best-team
parsable-cli analytics:feed:credential:delete -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e -t
767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create external credential for analytics feed
USAGE
$ parsable-cli analytics:feed:credential:external:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an external credential for analytics feed for certain team, cluster and topic
EXAMPLES
parsable-cli analytics:feed:credential:external:create
parsable-cli analytics:feed:credential:external:create --team best-team
parsable-cli analytics:feed:credential:external:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch list of credentials for analytics feed
USAGE
$ parsable-cli analytics:feed:credential:get
OPTIONS
-c, --cluster=cluster [default: default] Cluster name
-n, --name=name (required) Topic name
-t, --teamId=teamId Team ID or subdomain the request is for
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch list of credentials by cluster, topic and Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:credential:get
$ parsable-cli analytics:feed:credential:show
$ parsable-cli analytics:feed:credential:info
EXAMPLES
parsable-cli analytics:feed:credential:get -n topic-name
parsable-cli analytics:feed:credential:get -c cluster-name -n topic-name
parsable-cli analytics:feed:credential:get -n topic-name -t best-team
parsable-cli analytics:feed:credential:show -n topic-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch one credential for topic in analytics feed
USAGE
$ parsable-cli analytics:feed:credential:get-one
OPTIONS
-c, --cluster=cluster [default: default] Cluster name
-i, --id=id (required) Credential id
-n, --name=name (required) Topic name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Fetch one credential for topic in analytics feed by its id, cluster, topic and Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:credential:get-one
$ parsable-cli analytics:feed:credential:show-one
$ parsable-cli analytics:feed:credential:info-one
EXAMPLES
parsable-cli analytics:feed:credential:get-one -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e
parsable-cli analytics:feed:credential:get-one -c cluster-name -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e
parsable-cli analytics:feed:credential:get-one -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e -t best-team
parsable-cli analytics:feed:credential:show-one -n topic-name -i 965621ca-7f50-48e7-8c0d-bf393422947e -t
767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create internal credential for analytics feed
USAGE
$ parsable-cli analytics:feed:credential:internal:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an internal credential for analytics feed for certain team, cluster and topic
EXAMPLES
parsable-cli analytics:feed:credential:internal:create
parsable-cli analytics:feed:credential:internal:create --team best-team
parsable-cli analytics:feed:credential:internal:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Delete JDBC SAS credential in analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sas-credential:delete
OPTIONS
-k, --key=key (required) JDBC SAS credential key
-n, --name=name (required) JDBC SAS group name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete JDBC SAS credential in analytics feed by its key and Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:jdbc-sas-credential:delete -n some-name -k jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:delete -t best-team -n some-name -k jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:delete -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -n some-name -k
jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:delete --name some-name --key jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:delete --teamId best-team --name some-name -k jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:delete --teamId 767d94cd-2c48-455a-9da3-7f608c51f5f5 --name some-name
-k jdbc-sas-credential-key
See code: @wearableintelligence/plugin-data-shipper-cli
Create external JDBC SAS credential for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sas-credential:external:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an external JDBC SAS credential for analytics feed for certain team
EXAMPLES
parsable-cli analytics:feed:jdbc-sas-credential:external:create
parsable-cli analytics:feed:jdbc-sas-credential:external:create -t best-team
parsable-cli analytics:feed:jdbc-sas-credential:external:create -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
parsable-cli analytics:feed:jdbc-sas-credential:external:create --team best-team
parsable-cli analytics:feed:jdbc-sas-credential:external:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch list of JDBC SAS credentials for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sas-credential:get
OPTIONS
-n, --name=name (required) JDBC SAS group name
-t, --teamId=teamId Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch list of JDBC SAS credentials by Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:jdbc-sas-credential:get
$ parsable-cli analytics:feed:jdbc-sas-credential:show
$ parsable-cli analytics:feed:jdbc-sas-credential:info
EXAMPLES
parsable-cli analytics:feed:jdbc-sas-credential:get -n some-name
parsable-cli analytics:feed:jdbc-sas-credential:get -t best-team -n some-name
parsable-cli analytics:feed:jdbc-sas-credential:get --teamId best-team --name some-name
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch one JDBC SAS credential in analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sas-credential:get-one
OPTIONS
-k, --key=key (required) JDBC SAS credential key
-n, --name=name (required) JDBC SAS group name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Fetch one JDBC SAS credential in analytics feed by its key and Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:jdbc-sas-credential:get-one
$ parsable-cli analytics:feed:jdbc-sas-credential:show-one
$ parsable-cli analytics:feed:jdbc-sas-credential:info-one
EXAMPLES
parsable-cli analytics:feed:jdbc-sas-credential:get-one -n some-name -k jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:get-one -t best-team -n some-name -k jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:get-one -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -n some-name -k
jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:get-one --name some-name --key jdbc-sas-credential-key
parsable-cli analytics:feed:jdbc-sas-credential:get-one --teamId best-team --name some-name --key
jdbc-sas-credential-key
See code: @wearableintelligence/plugin-data-shipper-cli
Create internal JDBC SAS credential for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sas-credential:internal:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an internal JDBC SAS credential for analytics feed for certain team
EXAMPLES
parsable-cli analytics:feed:jdbc-sas-credential:internal:create
parsable-cli analytics:feed:jdbc-sas-credential:internal:create -t best-team
parsable-cli analytics:feed:jdbc-sas-credential:internal:create -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
parsable-cli analytics:feed:jdbc-sas-credential:internal:create --team best-team
parsable-cli analytics:feed:jdbc-sas-credential:internal:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Delete JDBC sink for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sink:delete
OPTIONS
-n, --name=name (required) JDBC sink name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete JDBC sink for analytics feed by Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:jdbc-sink:delete -n some-name
parsable-cli analytics:feed:jdbc-sink:delete -t best-team -n some-name
parsable-cli analytics:feed:jdbc-sink:delete --teamId 767d94cd-2c48-455a-9da3-7f608c51f5f5 --name some-name
See code: @wearableintelligence/plugin-data-shipper-cli
Create external JDBC sink for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sink:external:create
OPTIONS
-s, --sync Wait for JDBC sink to be fully created
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an external JDBC sink for analytics feed for certain team by Team ID or Subdomain
EXAMPLES
parsable-cli analytics:feed:jdbc-sink:external:create
parsable-cli analytics:feed:jdbc-sink:external:create -s
parsable-cli analytics:feed:jdbc-sink:external:create --teamId best-team
parsable-cli analytics:feed:jdbc-sink:external:create --teamId 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch list of JDBC sinks for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sink:get
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch list of JDBC sinks for all teams. This command requires a super admin role.
ALIASES
$ parsable-cli analytics:feed:jdbc-sink:get
$ parsable-cli analytics:feed:jdbc-sink:show
$ parsable-cli analytics:feed:jdbc-sink:info
EXAMPLE
parsable-cli analytics:feed:jdbc-sink:get
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch JDBC sink for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sink:get-one
OPTIONS
-n, --name=name (required) JDBC sink name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Fetch JDBC sink for analytics feed by Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:jdbc-sink:get-one
$ parsable-cli analytics:feed:jdbc-sink:show-one
$ parsable-cli analytics:feed:jdbc-sink:info-one
EXAMPLES
parsable-cli analytics:feed:jdbc-sink:get-one -n some-name
parsable-cli analytics:feed:jdbc-sink:get-one -t best-team -n some-name
parsable-cli analytics:feed:jdbc-sink:show-one --teamId 767d94cd-2c48-455a-9da3-7f608c51f5f5 --name some-name
See code: @wearableintelligence/plugin-data-shipper-cli
Create internal JDBC sink for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sink:internal:create
OPTIONS
-s, --sync Wait for JDBC sink to be fully created
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an internal JDBC sink for analytics feed for certain team by Team ID or Subdomain
EXAMPLES
parsable-cli analytics:feed:jdbc-sink:internal:create
parsable-cli analytics:feed:jdbc-sink:internal:create -s
parsable-cli analytics:feed:jdbc-sink:internal:create --teamId best-team
parsable-cli analytics:feed:jdbc-sink:internal:create --teamId 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Start JDBC sink for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sink:start
OPTIONS
-n, --name=name (required) JDBC sink name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Start JDBC sink for analytics feed by Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:jdbc-sink:start -n some-name
parsable-cli analytics:feed:jdbc-sink:start -t best-team -n some-name
parsable-cli analytics:feed:jdbc-sink:start --teamId 767d94cd-2c48-455a-9da3-7f608c51f5f5 --name some-name
See code: @wearableintelligence/plugin-data-shipper-cli
Stop JDBC sink for analytics feed
USAGE
$ parsable-cli analytics:feed:jdbc-sink:stop
OPTIONS
-n, --name=name (required) JDBC sink name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Stop JDBC sink for analytics feed by Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:jdbc-sink:stop -n some-name
parsable-cli analytics:feed:jdbc-sink:stop -t best-team -n some-name
parsable-cli analytics:feed:jdbc-sink:stop --teamId 767d94cd-2c48-455a-9da3-7f608c51f5f5 --name some-name
See code: @wearableintelligence/plugin-data-shipper-cli
Delete SAS credential in analytics feed
USAGE
$ parsable-cli analytics:feed:sas-credential:delete
OPTIONS
-c, --cluster=cluster (required) SAS credential cluster
-k, --key=key (required) SAS credential key
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete SAS credential in analytics feed by its key, cluster and Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:sas-credential:delete -k sas-credential-key -c cluster-name
parsable-cli analytics:feed:sas-credential:delete -k sas-credential-key -c cluster-name -t best-team
parsable-cli analytics:feed:sas-credential:delete -k sas-credential-key -c cluster-name -t
767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create external SAS credential for analytics feed
USAGE
$ parsable-cli analytics:feed:sas-credential:external:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an external SAS credential for analytics feed for certain team
EXAMPLES
parsable-cli analytics:feed:sas-credential:external:create
parsable-cli analytics:feed:sas-credential:external:create --team best-team
parsable-cli analytics:feed:sas-credential:external:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch list of SAS credentials for analytics feed
USAGE
$ parsable-cli analytics:feed:sas-credential:get
OPTIONS
-c, --cluster=cluster (required) SAS credential cluster
-t, --teamId=teamId Team ID or subdomain the request is for
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch list of SAS credentials by Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:sas-credential:get
$ parsable-cli analytics:feed:sas-credential:show
$ parsable-cli analytics:feed:sas-credential:info
EXAMPLES
parsable-cli analytics:feed:sas-credential:get -c cluster-name
parsable-cli analytics:feed:sas-credential:get -c cluster-name -t best-team
parsable-cli analytics:feed:sas-credential:show -c cluster-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch one SAS credential in analytics feed
USAGE
$ parsable-cli analytics:feed:sas-credential:get-one
OPTIONS
-c, --cluster=cluster (required) SAS credential cluster
-k, --key=key (required) SAS credential key
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Fetch one SAS credential in analytics feed by its key, cluster and Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:sas-credential:get-one
$ parsable-cli analytics:feed:sas-credential:show-one
$ parsable-cli analytics:feed:sas-credential:info-one
EXAMPLES
parsable-cli analytics:feed:sas-credential:get-one -k sas-credential-key -c cluster-name
parsable-cli analytics:feed:sas-credential:get-one -k sas-credential-key -c cluster-name -t best-team
parsable-cli analytics:feed:sas-credential:show-one -k sas-credential-key -c cluster-name -t
767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create internal SAS credential for analytics feed
USAGE
$ parsable-cli analytics:feed:sas-credential:internal:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an internal SAS credential for analytics feed for certain team
EXAMPLES
parsable-cli analytics:feed:sas-credential:internal:create
parsable-cli analytics:feed:sas-credential:internal:create --team best-team
parsable-cli analytics:feed:sas-credential:internal:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Delete schema registry credentials
USAGE
$ parsable-cli analytics:feed:schema-registry:credential:delete
OPTIONS
-n, --name=name (required) Credential name
-t, --teamId=teamId Team ID or subdomain the request is for
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Permanently delete schema registry credentials. WARNING: this could not be undone.
EXAMPLES
parsable-cli analytics:feed:schema-registry:credential:delete -n my-credential-name
parsable-cli analytics:feed:schema-registry:credential:delete -t my-team-name -n my-credential-name
See code: @wearableintelligence/plugin-data-shipper-cli
Create an external credential for schema registry
USAGE
$ parsable-cli analytics:feed:schema-registry:credential:external:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an external credential for schema registry.
Result includes username and password to be used in Schema Registry clients for http Basic auth scheme.
EXAMPLES
parsable-cli analytics:feed:schema-registry:credential:external:create
parsable-cli analytics:feed:schema-registry:credential:external:create --t my-team
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch credentials for schema registry
USAGE
$ parsable-cli analytics:feed:schema-registry:credential:get
OPTIONS
-n, --name=name (required) Credential name
-t, --teamId=teamId Team ID or subdomain the request is for
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch credentials for Schema Registry including name, username and password.
ALIASES
$ parsable-cli analytics:feed:schema-registry:credential:get
$ parsable-cli analytics:feed:schema-registry:credential:info
EXAMPLES
parsable-cli analytics:feed:schema-registry:credential:get -n my-credential-name
parsable-cli analytics:feed:schema-registry:credential:get -t my-team-name -n my-credential-name
See code: @wearableintelligence/plugin-data-shipper-cli
Create an internal credential for schema registry
USAGE
$ parsable-cli analytics:feed:schema-registry:credential:internal:create
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create an internal credential for schema registry.
Result includes username and password to be used in Schema Registry clients for http Basic auth scheme.
EXAMPLES
parsable-cli analytics:feed:schema-registry:credential:internal:create
parsable-cli analytics:feed:schema-registry:credential:internal:create --t my-team
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch list of credentials for schema registry
USAGE
$ parsable-cli analytics:feed:schema-registry:credential:list
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch list of credentials for Schema Registry including name, username and password.
ALIASES
$ parsable-cli analytics:feed:schema-registry:credential:list
EXAMPLES
parsable-cli analytics:feed:schema-registry:credential:list
parsable-cli analytics:feed:schema-registry:credential:list -t my-team-name
See code: @wearableintelligence/plugin-data-shipper-cli
Consume Data Feed messages
USAGE
$ parsable-cli analytics:feed:topic:consume
OPTIONS
-b, --from-beginning Read topic from the beginning
-g, --group=group Consumer group
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Creates a Kafka based consumer for a Data Feed topic in Azure Event Hubs and prints received messages.
ALIASES
$ parsable-cli analytics:feed:topic:read
EXAMPLES
parsable-cli analytics:feed:topic:consume -g my-consumer-group --from-beginning
parsable-cli analytics:feed:topic:read
See code: @wearableintelligence/plugin-data-shipper-cli
Delete topic for analytics feed
USAGE
$ parsable-cli analytics:feed:topic:delete
OPTIONS
-c, --cluster=cluster [default: default] Cluster name
-n, --name=name (required) Topic name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete topic for analytics feed by its name, cluster and Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:topic:delete -n topic-name
parsable-cli analytics:feed:topic:delete -n topic-name -c cluster-name
parsable-cli analytics:feed:topic:delete -n topic-name -t best-team
parsable-cli analytics:feed:topic:delete -n topic-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create external topic for analytics feed
USAGE
$ parsable-cli analytics:feed:topic:external:create
OPTIONS
-s, --sync Wait for topic to fully create
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create a topic for analytics feed for certain team by Team ID or Subdomain
EXAMPLES
parsable-cli analytics:feed:topic:external:create
parsable-cli analytics:feed:topic:external:create -s
parsable-cli analytics:feed:topic:external:create --team best-team
parsable-cli analytics:feed:topic:external:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch list of topics for analytics feed
USAGE
$ parsable-cli analytics:feed:topic:get
OPTIONS
-a, --all Request all available topics for all teams.
-j, --jdbc Include jdbc sink topics
-t, --teamId=teamId Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch list of topics by Team ID or Subdomain.
Or fetch all topics for all teams. Last action requires a super admin role.
ALIASES
$ parsable-cli analytics:feed:topic:get
$ parsable-cli analytics:feed:topic:show
$ parsable-cli analytics:feed:topic:info
EXAMPLES
parsable-cli analytics:feed:topic:get
parsable-cli analytics:feed:topic:get -a
parsable-cli analytics:feed:topic:get -t best-team
parsable-cli analytics:feed:topic:show -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch one topic for analytics feed
USAGE
$ parsable-cli analytics:feed:topic:get-one
OPTIONS
-c, --cluster=cluster [default: default] Cluster name
-n, --name=name (required) Topic name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Fetch one topic for analytics feed by its name, cluster and Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:feed:topic:get-one
$ parsable-cli analytics:feed:topic:show-one
$ parsable-cli analytics:feed:topic:info-one
EXAMPLES
parsable-cli analytics:feed:topic:get-one -n topic-name
parsable-cli analytics:feed:topic:get-one -n topic-name -c cluster-name
parsable-cli analytics:feed:topic:get-one -n topic-name -t best-team
parsable-cli analytics:feed:topic:show-one -n topic-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create internal topic for analytics feed
USAGE
$ parsable-cli analytics:feed:topic:internal:create
OPTIONS
-s, --sync Wait for topic to fully create
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create a topic for analytics feed for certain team by Team ID or Subdomain
EXAMPLES
parsable-cli analytics:feed:topic:internal:create
parsable-cli analytics:feed:topic:internal:create -s
parsable-cli analytics:feed:topic:internal:create --team best-team
parsable-cli analytics:feed:topic:internal:create --team 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Start topic for analytics feed
USAGE
$ parsable-cli analytics:feed:topic:start
OPTIONS
-c, --cluster=cluster [default: default] Cluster name
-n, --name=name (required) Topic name
-p, --fromPrevious Start from previous position. Relevant only for notification use case, will be ignored for
others.
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Start topic for analytics feed by its name, cluster and Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:topic:start -n topic-name
parsable-cli analytics:feed:topic:start -n topic-name -p
parsable-cli analytics:feed:topic:start -n topic-name -c cluster-name
parsable-cli analytics:feed:topic:start -n topic-name -t best-team
parsable-cli analytics:feed:topic:start -n topic-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Stop topic for analytics feed
USAGE
$ parsable-cli analytics:feed:topic:stop
OPTIONS
-c, --cluster=cluster [default: default] Cluster name
-n, --name=name (required) Topic name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Stop topic for analytics feed by its name, cluster and Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:feed:topic:stop -n topic-name
parsable-cli analytics:feed:topic:stop -n topic-name -c cluster-name
parsable-cli analytics:feed:topic:stop -n topic-name -t best-team
parsable-cli analytics:feed:topic:stop -n topic-name -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Add team's report to the group
USAGE
$ parsable-cli analytics:report:group:add
OPTIONS
-g, --groupName=groupName (required) Group name
-i, --internal Is trigger internal
-n, --triggerName=triggerName Trigger name
-t, --teamId=teamId (required) Team ID
DESCRIPTION
...
Report for team should be scheduled and disabled. To be available for the group, group and trigger should
have equal intervalMinutes, fullness and incrementalSnapshots settings. Also start times (not dates) for the group and
trigger's
schedule should be close enough (60 minutes difference by default).
EXAMPLES
parsable-cli analytics:report:group:add -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name
parsable-cli analytics:report:group:add -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name -n trigger-name
parsable-cli analytics:report:group:add -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name -n trigger-name
--internal
parsable-cli analytics:report:group:add -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name -n trigger-name -i
See code: @wearableintelligence/plugin-data-shipper-cli
Find available groups
USAGE
$ parsable-cli analytics:report:group:available
OPTIONS
-i, --internal Is trigger internal
-n, --triggerName=triggerName Trigger name
-t, --teamId=teamId Team ID
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Find groups available for a particular trigger. To be available, group and trigger's report schedule should
have equal intervalMinutes, fullness and incrementalSnapshots settings. Also start times (not dates) for group and
trigger's
schedule report should be close enough (60 minutes difference by default)
EXAMPLES
parsable-cli analytics:report:group:available
parsable-cli analytics:report:group:available -t team-id
parsable-cli analytics:report:group:available -t team-id -n trigger-name
parsable-cli analytics:report:group:available -t team-id -n trigger-name --internal
parsable-cli analytics:report:group:available -t team-id -n trigger-name -i
See code: @wearableintelligence/plugin-data-shipper-cli
Delete an existing group
USAGE
$ parsable-cli analytics:report:group:delete
OPTIONS
-g, --groupName=groupName (required) Group name
DESCRIPTION
...
Group can be deleted if only it doesn't have assigned triggers.
EXAMPLE
parsable-cli analytics:report:group:delete -g group-name
See code: @wearableintelligence/plugin-data-shipper-cli
Get group by name
USAGE
$ parsable-cli analytics:report:group:get
OPTIONS
-g, --groupName=groupName (required) Group name
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch group with parameters by name.
EXAMPLE
parsable-cli analytics:report:group:get -g group-name
See code: @wearableintelligence/plugin-data-shipper-cli
List existing groups
USAGE
$ parsable-cli analytics:report:group:list
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch all existing groups with parameters.
EXAMPLE
parsable-cli analytics:report:group:list
See code: @wearableintelligence/plugin-data-shipper-cli
Remove trigger from a group
USAGE
$ parsable-cli analytics:report:group:remove
OPTIONS
-g, --groupName=groupName (required) Group name
-i, --internal Is trigger internal
-n, --triggerName=triggerName Trigger name
-t, --teamId=teamId (required) Team ID
EXAMPLES
parsable-cli analytics:report:group:remove -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name
parsable-cli analytics:report:group:remove -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name -n trigger-name
parsable-cli analytics:report:group:remove -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name -n trigger-name
--internal
parsable-cli analytics:report:group:remove -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -g group-name -n trigger-name -i
See code: @wearableintelligence/plugin-data-shipper-cli
Create new group
USAGE
$ parsable-cli analytics:report:group:set
DESCRIPTION
...
Group can be used for running batch of teams scheduled reports together which
significantly reduces costs of reports infrastructure. If some of reports have similar start time and interval
settings it's
highly recommended to run them as a part of the same group.
EXAMPLE
parsable-cli analytics:report:group:set
See code: @wearableintelligence/plugin-data-shipper-cli
For maintenance only. Stop producing all reports.
USAGE
$ parsable-cli analytics:report:manage:creation:disable
OPTIONS
-c, --cancelPipelines Cancel all running pipelines
DESCRIPTION
...
Stop producing and uploading all reports: disable all triggers and cancel all export pipelines if need.
EXAMPLES
parsable-cli analytics:report:manage:disable
parsable-cli analytics:report:manage:disable -c
See code: @wearableintelligence/plugin-data-shipper-cli
For maintenance only. Restore reports creation.
USAGE
$ parsable-cli analytics:report:manage:creation:enable
DESCRIPTION
...
Restore producing and uploading all reports: enable all triggers back.
EXAMPLE
parsable-cli analytics:report:manage:enable
See code: @wearableintelligence/plugin-data-shipper-cli
For maintenance only. Get global report creation state.
USAGE
$ parsable-cli analytics:report:manage:creation:get
DESCRIPTION
...
Get global analytic report creation state.
ALIASES
$ parsable-cli analytics:report:manage:creation:get
$ parsable-cli analytics:report:manage:creation:show
$ parsable-cli analytics:report:manage:creation:info
EXAMPLE
parsable-cli analytics:report:manage:creation:get
See code: @wearableintelligence/plugin-data-shipper-cli
For internal Parsable use only. Delete an existed and disabled quantified users schedule for uploading
USAGE
$ parsable-cli analytics:report:quantified-users:delete
DESCRIPTION
...
Delete an existed and disabled schedule for uploading quantified users report.
EXAMPLE
parsable-cli analytics:report:quantified-user:delete
See code: @wearableintelligence/plugin-data-shipper-cli
For internal Parsable use only. Enable/disable a configured quantified users schedule for uploading
USAGE
$ parsable-cli analytics:report:quantified-users:enable MODE
ARGUMENTS
MODE (on|off) "on" for turn schedule on, "off" for turn it off
DESCRIPTION
...
Enable/disable a configured schedule for uploading quantified users report.
EXAMPLE
parsable-cli analytics:report:quantified-user:enable on
See code: @wearableintelligence/plugin-data-shipper-cli
For internal Parsable use only. Fetch quantified users schedule of uploading
USAGE
$ parsable-cli analytics:report:quantified-users:get
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch available schedule of quantified user report.
EXAMPLE
parsable-cli analytics:report:quantified-user:get
See code: @wearableintelligence/plugin-data-shipper-cli
For internal Parsable use only. Create/update a quantified users schedule for uploading
USAGE
$ parsable-cli analytics:report:quantified-users:set
DESCRIPTION
...
Create/update a schedule for uploading quantified users report.
When try to update active existed trigger it should be stopped first.
Command runs in interactive mode.
EXAMPLE
parsable-cli analytics:report:quantified-user:set
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch a retention policy for analytics reports
USAGE
$ parsable-cli analytics:report:retention:get
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
DESCRIPTION
...
Fetch a retention policy for analytics reports by Team ID or Subdomain.
ALIASES
$ parsable-cli analytics:report:retention:get
$ parsable-cli analytics:report:retention:show
$ parsable-cli analytics:report:retention:info
EXAMPLES
parsable-cli analytics:report:retention:get -t best-team
parsable-cli analytics:report:retention:show -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Set/change/delete a retention policy for analytics reports
USAGE
$ parsable-cli analytics:report:retention:set TTL [UNIT]
ARGUMENTS
TTL ttl (digit), -1 to turn off retention policy
UNIT (min|hours|days) [default: DAYS] unit of ttl
OPTIONS
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Set/change/delete a retention policy for analytics reports by Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:report:retention:set -t best-team 10
parsable-cli analytics:report:retention:set -t best-team 10 days
parsable-cli analytics:report:retention:set -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -1
See code: @wearableintelligence/plugin-data-shipper-cli
Delete an existing and disabled external uploading schedule
USAGE
$ parsable-cli analytics:report:upload:external:delete
OPTIONS
-n, --name=name Trigger name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete an existing and disabled external schedule for uploading analytic report for certain team by Team ID or
Subdomain.
EXAMPLES
parsable-cli analytics:report:upload:external:delete
parsable-cli analytics:report:upload:external:delete -t best-team
parsable-cli analytics:report:upload:external:delete -t best-team -n external-trigger-name
parsable-cli analytics:report:upload:external:delete -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Enable/disable a configured external schedule for uploading
USAGE
$ parsable-cli analytics:report:upload:external:enable MODE
ARGUMENTS
MODE (on|off) "on" for turn schedule on, "off" for turn it off
OPTIONS
-n, --name=name Trigger name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Enable/disable a configured external schedule for uploading analytic report for certain team by Team ID or Subdomain.
EXAMPLES
parsable-cli analytics:report:upload:external:enable on
parsable-cli analytics:report:upload:external:enable -n trigger-name on
parsable-cli analytics:report:upload:external:enable -t best-team off
parsable-cli analytics:report:upload:external:enable -t best-team -n trigger-name off
parsable-cli analytics:report:upload:external:enable -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 on
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch external schedule of uploading
USAGE
$ parsable-cli analytics:report:upload:external:get
OPTIONS
-a, --all Request all available schedules for all teams.
-n, --name=name Schedule name
-t, --teamId=teamId Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter Filter property by partial string matching, ex: --filter "Interval (min)"=123
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch available external schedule of uploading by Team ID or Subdomain.
Or fetch all schedules available for all teams. Last action requires the super admin role.
ALIASES
$ parsable-cli analytics:report:upload:external:get
$ parsable-cli analytics:report:upload:external:show
$ parsable-cli analytics:report:upload:external:info
EXAMPLES
parsable-cli analytics:report:upload:external:get
parsable-cli analytics:report:upload:external:get -a
parsable-cli analytics:report:upload:external:get -t best-team
parsable-cli analytics:report:upload:external:get -t best-team -n my-custom-name
parsable-cli analytics:report:upload:external:show -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create/update an external schedule for uploading
USAGE
$ parsable-cli analytics:report:upload:external:set
OPTIONS
-n, --name=name Name of the trigger
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create/update a schedule for uploading analytic report for certain team by Team ID or Subdomain.
When try to update active existed trigger it should be stopped first.
Command runs in interactive mode.
If no name parameter is specified then the default trigger is going to be updated.
EXAMPLES
parsable-cli analytics:report:upload:external:set
parsable-cli analytics:report:upload:external:set -t best-team
parsable-cli analytics:report:upload:external:set -t best-team -n custom-trigger-name
parsable-cli analytics:report:upload:external:set -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Test data uploading on demand
USAGE
$ parsable-cli analytics:report:upload:external:test
OPTIONS
-n, --name=name Trigger name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Test data uploading on demand for predefined upload directory for certain team by Team ID or Subdomain.
Command to create a test file and try to upload it to the customer directory.
Return file name to lookup or return errors if exists.
Before using this command make sure there is a predefined external uploading configuration for team:
command parsable-cli analytics:report:upload:external:get -t teamId
EXAMPLES
parsable-cli analytics:report:upload:external:test
parsable-cli analytics:report:upload:external:test -n trigger-name
parsable-cli analytics:report:upload:external:test -t best-team
parsable-cli analytics:report:upload:external:test -t best-team -n trigger-name
parsable-cli analytics:report:upload:external:test -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Delete an existing and disabled external uploading schedule
USAGE
$ parsable-cli analytics:report:upload:internal:delete
OPTIONS
-n, --name=name (required) Trigger name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Delete an existing and disabled external schedule for uploading analytic report for certain team by Team ID or
Subdomain.
EXAMPLES
parsable-cli analytics:report:upload:external:delete -n internal-trigger-name
parsable-cli analytics:report:upload:external:delete -t best-team -n internal-trigger-name
parsable-cli analytics:report:upload:external:delete -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -n internal-trigger-name
See code: @wearableintelligence/plugin-data-shipper-cli
Enable/disable a configured internal schedule for uploading
USAGE
$ parsable-cli analytics:report:upload:internal:enable MODE
ARGUMENTS
MODE (on|off) "on" for turn schedule on, "off" for turn it off
OPTIONS
-n, --name=name (required) Trigger name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Enable/disable a configured internal schedule for uploading analytic report for certain team by Team ID or Subdomain.
Trigger name is required.
EXAMPLES
parsable-cli analytics:report:upload:internal:enable -n trigger-name on
parsable-cli analytics:report:upload:internal:enable -t best-team off -n trigger-name
parsable-cli analytics:report:upload:internal:enable -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -n trigger-name on
See code: @wearableintelligence/plugin-data-shipper-cli
Fetch internal schedule of uploading
USAGE
$ parsable-cli analytics:report:upload:internal:get
OPTIONS
-a, --all Request all available schedules for all teams.
-n, --name=name Schedule name
-t, --teamId=teamId Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter Filter property by partial string matching, ex: --filter "Interval (min)"=123
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch available internal schedule of uploading by Team ID or Subdomain.
Or fetch all schedules available for all teams. Last action requires the super admin role.
ALIASES
$ parsable-cli analytics:report:upload:internal:get
$ parsable-cli analytics:report:upload:internal:show
$ parsable-cli analytics:report:upload:internal:info
EXAMPLES
parsable-cli analytics:report:upload:internal:get
parsable-cli analytics:report:upload:internal:get -a
parsable-cli analytics:report:upload:internal:get -t best-team -n my-custom-name
parsable-cli analytics:report:upload:internal:show -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Create/update an internal schedule for uploading
USAGE
$ parsable-cli analytics:report:upload:internal:set
OPTIONS
-n, --name=name Name of the trigger
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Create/update a schedule for uploading analytic report for certain team by Team ID or Subdomain.
When try to update active existed trigger it should be stopped first.
Command runs in interactive mode.
EXAMPLES
parsable-cli analytics:report:upload:internal:set
parsable-cli analytics:report:upload:internal:set -t best-team
parsable-cli analytics:report:upload:internal:set -t best-team -n custom-trigger-name
parsable-cli analytics:report:upload:internal:set -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-data-shipper-cli
Test data uploading on demand
USAGE
$ parsable-cli analytics:report:upload:internal:test
OPTIONS
-n, --name=name (required) Trigger name
-t, --teamId=teamId Team ID or subdomain the request is for
DESCRIPTION
...
Test data uploading on demand for predefined upload directory for certain team by Team ID or Subdomain.
Command to create a test file and try to upload it to the customer directory. Trigger name is required.
Return file name to lookup or return errors if exists.
Before using this command make sure there is a predefined internal uploading configuration for team:
command parsable-cli analytics:report:upload:internal:get -t teamId -n trigger-name
EXAMPLES
parsable-cli analytics:report:upload:internal:test -n trigger-name
parsable-cli analytics:report:upload:internal:test -t best-team -n trigger-name
parsable-cli analytics:report:upload:internal:test -t 767d94cd-2c48-455a-9da3-7f608c51f5f5 -n trigger-name
See code: @wearableintelligence/plugin-data-shipper-cli
Add new attribute values
USAGE
$ parsable-cli attributes:add
OPTIONS
-a, --attributes=attributes (required) Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to add attribute values to a team, this is purely additive and will not remove any values. Attribute
input format is key=value|value|value
ALIASES
$ parsable-cli attrs:add
EXAMPLES
parsable-cli attributes:add -t my-team -a Location='San Francisco|Austin|Vancouver'
parsable-cli attributes:add --team a-squad -a 'Location'='Mexico City' -a 'Business Unit'='Food|Alcohol'
parsable-cli attrs:add -team team-b -a 'Location'='Berlin 1|Berlin 2' -a 'Business Function'='Planning|Operations'
See code: @wearableintelligence/plugin-admin-cli
List attribute values for a team
USAGE
$ parsable-cli attributes:list
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
List the attribute and attribute values for a team.
ALIASES
$ parsable-cli attributes:ls
$ parsable-cli attrs:list
$ parsable-cli attrs:ls
EXAMPLES
parsable-cli attributes:list -t the-team
parsable-cli attributes:list --team the-team
parsable-cli attrs:list -t 577cf2ed-b5b9-4bd4-a09d-f4a6c2571c13
parsable-cli attrs:ls --team 577cf2ed-b5b9-4bd4-a09d-f4a6c2571c13
See code: @wearableintelligence/plugin-admin-cli
Remove attribute values from a team
USAGE
$ parsable-cli attributes:remove
OPTIONS
-a, --attributes=attributes (required) Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Remove one or many attribute values on a team. Attribute input format is key=value|value|value
ALIASES
$ parsable-cli attributes:archive
$ parsable-cli attributes:rm
$ parsable-cli attrs:remove
$ parsable-cli attrs:archive
$ parsable-cli attrs:rm
EXAMPLES
parsable-cli attributes:remove -t my-team -a Location='San Francisco|Austin|Vancouver'
parsable-cli attributes:archive --team a-squad -a 'Location'='Mexico City' -a 'Business Unit'='Food|Alcohol'
parsable-cli attrs:rm -team team-b -a 'Location'='Berlin 1|Berlin 2' -a 'Business Function'='Planning|Operations'
See code: @wearableintelligence/plugin-admin-cli
Delete execution data corresponding to a specific Input Field on a Job.
USAGE
$ parsable-cli exec-data:delete
OPTIONS
-A, --all
When set, deletes all execution data regardless of when it was sent to the server.
-c, --fields-csv=fields-csv
The absolute path to a CSV file containing rows of field-id/job-base-step-id pairs.
The CSV file must not start with a header row (the first line must be the first field locator you wish to delete
data for).
Each row should have as its first element the field id, and as its second element the job-base-step id.
Example:
field_id,job_base_step_id
abc123,def456
ghi789,jkl012
-f, --field-id=field-id
The id of the Field to delete execution data from.
-j, --job-base-step-id=job-base-step-id
The jobBaseStepId of the Field's parent Step.
--force
When set, skips the "Are you sure" prompt.
--from-time=from-time
Any execution data sent to the server before this timestamp will not be deleted (format: UNIX, seconds since epoch).
--until-time=until-time
Any execution data sent to the server on or after this timestamp will not be deleted (format: UNIX, seconds since
epoch).
DESCRIPTION
Fields are uniquely identified by locators, which are combinations of:
1. the 'id' of the Field itself, plus
2. the 'jobBaseStepId' of the Field's parent Step
A single locator can be specified inline, using the arguments --field-id and --job-base-step-id.
Alternatively, a list of locators can be provided in the form of a CSV file via the --fields-csv argument.
(More details provided below in the context of the --fields-csv argument.)
A time range must be set using the flags:
1. 'from-time'
2. 'until-time'
3. both of the preceding, or
4. 'all'
If no range is set the delete command will not run.
If 'all' is combined with 'from-time' or 'until-time' the command will not run.
EXAMPLES
parsable-cli exec-data:delete --field-id=abc123 --job-base-step-id=def456 --all
parsable-cli exec-data:delete -f abc123 -j def456 -A
parsable-cli exec-data:delete --field-id=abc123 --job-base-step-id=def456 --from-time=123456789
parsable-cli exec-data:delete --field-id=abc123 --job-base-step-id=def456 --until-time=123456789
parsable-cli exec-data:delete --field-id=abc123 --job-base-step-id=def456 --from-time=123456789 --until-time=123456790
parsable-cli exec-data:delete --fields-csv=/absolute/path/to/my/file.csv --all
parsable-cli exec-data:delete -c /absolute/path/to/my/file.csv -A
parsable-cli exec-data:delete -c /absolute/path/to/my/file.csv -A --force
See code: @wearableintelligence/plugin-author-cli
display help for parsable-cli
USAGE
$ parsable-cli help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
Create jobs.
USAGE
$ parsable-cli jobs:create
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--number-of-jobs=number-of-jobs number of job(s) to be created, will default to 1 if left out
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
--team-id=team-id (required) Id of the team who will own the jobs
--template-ids=template-ids (required) template id(s) to be assigned for the created jobs and should match to the
number of jobs (comma-separated)
--title=title (required) title of the job(s) and should match to the number of jobs
(comma-separated)
DESCRIPTION
Send a request to create a job(s) and assigned templates.
Currently it only supports on-demand job type.
EXAMPLES
parsable-cli jobs:create --team-id=abc123 --title='Job Sample 1'
parsable-cli jobs:create --team-id=abc123 --number-of-jobs=2 --title='Job Sample 1,Job Sample 2'
parsable-cli jobs:create --team-id=abc123 --number-of-jobs=2 --title='Job Sample 1,Job Sample 2'
--template-ids=<template_id>,<template_id>
See code: @wearableintelligence/plugin-author-cli
Delete jobs and issues listed in CSV files of lookup/database ids.
USAGE
$ parsable-cli jobs:delete
OPTIONS
-i, --issues-csv=issues-csv
Path to a CSV holding the issue lookup ids to be deleted.
There should be no header row in the CSV.
Each row is a single item: the lookup id (integer or 'issue-123' format key) or database id (UUID) of the issue to
be deleted.
Maximum file length is 5K rows/issues. Beyond that, the CLI may fail to process.
Example CSV contents:
1234
6c807fd4-6594-11eb-ae93-0242ac130002
5678
75196fd4-6594-11eb-ae93-0242ac130002
-j, --jobs-csv=jobs-csv
Path to a CSV holding the job lookup ids to be deleted.
There should be no header row in the CSV.
Each row is a single item: the lookup id (integer or 'job-123' format key) or database id (UUID) of the job to be
deleted.
Maximum file length is 5K rows/jobs. Beyond that, the CLI may fail to process.
Example CSV contents:
1234
6c807fd4-6594-11eb-ae93-0242ac130002
5678
75196fd4-6594-11eb-ae93-0242ac130002
-t, --team-id=team-id
(required) Id of the team owning the jobs
--force
When set, skips the "Are you sure?" prompt
DESCRIPTION
If a job/issue cannot be deleted because it is referenced (depended upon) by another job/issue, then a list of those
dependents will be output to the files descendant-issues.csv and descendant-jobs.csv accordingly.
These lists can be fed back into the command on subsequent attempts, issues first and then jobs.
After the dependents are deleted, you can attempt to delete the original dependency job/issue that failed initially.
EXAMPLES
parsable-cli jobs:delete --team-id=abc123 --jobs-csv=path/to/the/file.csv
parsable-cli jobs:delete --team-id=abc123 --issues-csv=path/to/another/file.csv
parsable-cli jobs:delete -t abc123 -j path/to/the/file.csv -i path/to/another/file.csv
parsable-cli jobs:delete -t abc123 -i path/to/the/file.csv --force
See code: @wearableintelligence/plugin-author-cli
Sets a user context via browser for subsequent CLI calls to mothership env and to new microservice env.
USAGE
$ parsable-cli login
OPTIONS
-E, --env=env Name of environment to use (ie. production, staging)
-t, --team=team Team ID or subdomain the request is for
DESCRIPTION
...
Use this command to login to new microservice env and to mothership in the same time.
Important: browser is used during login.
EXAMPLES
parsable-cli login
parsable-cli login -t 'my-team'
parsable-cli login -t '95ecc380-afe9-11e4-9b6c-751b66dd541e'
parsable-cli login -t 'my-team' -E production
See code: @wearableintelligence/parsable-cli-common
Sets a user context for subsequent CLI calls (DEPRECATED)
USAGE
$ parsable-cli login-mothership
OPTIONS
-E, --env=env Name of environment to use (ie. production, staging)
-P, --password=password
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
--skip-team Skip team selection
DESCRIPTION
...
Use this command to login only in mothership. Command doesn't login to new microservice environment.
In order to login into mothership along with new microservice environment use "parsable-cli login" command.
EXAMPLES
parsable-cli login-mothership
parsable-cli login-mothership -t 'my-team'
parsable-cli login-mothership -t '95ecc380-afe9-11e4-9b6c-751b66dd541e'
parsable-cli login-mothership -t 'my-team' -u 'user@parsable.com'
parsable-cli login-mothership -u 'user@parsable.com' -P Pass1234 --skip-team
See code: @wearableintelligence/parsable-cli-common
View current environment
USAGE
$ parsable-cli me
DESCRIPTION
...
Use this command to see which environment and team is active
EXAMPLE
parsable-cli me
See code: @wearableintelligence/parsable-cli-common
Add Parameters
USAGE
$ parsable-cli params:add
OPTIONS
-O, --owner=ALL|JOB_TEMPLATE|STEP_GROUP|STEP|JOB|USER Parameter owner, will default to JOB_TEMPLATE if left out
-T, --type=TEXT|NUMBER|MULTI_SELECT_LIST|LIST (required) Parameter type
-d, --defaultValue=defaultValue Default value, if multi-select list, separate values by |
-k, --key=key (required) Parameter key name
-o, --options=options Sets options for list and multi select list types, separate
options by |
-r, --[no-]required Set flag if parameter is required, use --no-required if not
required
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to add parameters for a team
ALIASES
$ parsable-cli parameters:add
$ parsable-cli metadata:add
EXAMPLES
parsable-cli params:add -k 'Risk Level' -T TEXT -O STEP_GROUP -t corteva
parsable-cli params:add -k 'Color' -T LIST -d green -o 'green|red|blue|yellow'
parsable-cli params:add -k 'Shape' -T MULTI_SELECT_LIST -d 'big|round' --required
See code: @wearableintelligence/plugin-admin-cli
List parameters for a team
USAGE
$ parsable-cli params:list
OPTIONS
-a, --includeArchived Set this flag to include archived parameters in the response
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to view parameters (metadata) for a team
ALIASES
$ parsable-cli params:ls
$ parsable-cli parameters:list
$ parsable-cli parameters:ls
$ parsable-cli metadata:list
$ parsable-cli metadata:ls
EXAMPLES
parsable-cli params:list
parsable-cli parameters:ls
parsable-cli params:list -a
parsable-cli params:list --includeArchived
See code: @wearableintelligence/plugin-admin-cli
Update Parameters
USAGE
$ parsable-cli params:update
OPTIONS
-T, --type=TEXT|NUMBER|MULTI_SELECT_LIST|LIST Parameter type
-c, --clear-default Set this flag to clear the default value
-d, --default-value=default-value Default value, if multi-select list, separate values by |
-k, --key=key Parameter key name to update
-p, --parameterId=parameterId (required) Parameter ID
-r, --[no-]required Mark parameter as required, use --no-required if not required
-s, --sort-list Sorts list options alphabetically, this only works for list and multi
select list types
-t, --team=team Team ID or subdomain the request is for
--add-options=add-options Adds options for list and multi select list types, separate options by
"|"
--remove-options=remove-options Removes options for list and multi select list types, separate options
by "|", returns error if any option does not match the current ones
--rename-options=rename-options Renames options for list and multi select list types, separate obtions
by "|" and the new value with ":", returns error if any option does
snot match the current ones
DESCRIPTION
...
Use this command to update parameters for a team
ALIASES
$ parsable-cli parameters:update
$ parsable-cli metadata:update
EXAMPLES
parsable-cli params:update -p 3f83a5f7-6615-48d8-b520-4018b551ffa3 -k "Risk Level"
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -t LIST -d green -a "green|red|blue|yellow"
--sort-list
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -T MULTI_SELECT_LIST -d "big|round" --add-options
"big|small|round|square"
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -T MULTI_SELECT_LIST --remove-options="big|small"
parsable-cli params:update -p 2cdc5ba0-0a06-4958-8f79-eb53300d357a -T MULTI_SELECT_LIST -d "big|round"
--rename-options="pink:red|circle:rounded"
parsable-cli params:update -p c72d37ff-07b3-4d46-a00a-de48784e13ed --required
parsable-cli params:update -p c72d37ff-07b3-4d46-a00a-de48784e13ed --no-required
parsable-cli params:update -p c72d37ff-07b3-4d46-a00a-de48784e13ed --clear-default
See code: @wearableintelligence/plugin-admin-cli
Add new team policies
USAGE
$ parsable-cli policies:add
OPTIONS
-a, --action=VIEW|CREATE|EDIT|EXECUTE|PUBLISH|COLLABORATE|ARCHIVE
-e, --expression=expression
-o,
--object=USER|TEAM|JOB|JOB_TEMPLATE|TEMPLATE_SET|ISSUE|DATASHEET|POLICY|POLICY_SET|WORKFLOW|ANALYTICS|TEAM_SETTINGS|IN
TEGRATION_TEMPLATE|METADATA|METADATA_VALUE|ANALYTICS_2|IT_SETTINGS
-p, --policy=policy
-s,
--subject=USER|TEAM|JOB|JOB_TEMPLATE|TEMPLATE_SET|ISSUE|DATASHEET|POLICY|POLICY_SET|WORKFLOW|ANALYTICS|TEAM_SETTINGS|I
NTEGRATION_TEMPLATE|METADATA|METADATA_VALUE|ANALYTICS_2|IT_SETTINGS
-t, --team=team
Team ID or subdomain the request is for
-x, --extended
show extra columns
--columns=columns
only show provided columns (comma-separated)
--csv
output is csv format [alias: --output=csv]
--filter=filter
filter property by partial string matching, ex: name=foo
--no-header
hide table header from output
--no-truncate
do not truncate output to fit screen
--output=csv|json|yaml
output in a more machine friendly format
--sort=sort
property to sort by (prepend '-' for descending)
DESCRIPTION
...
Add one or many team policies. Use the policy flag if you want to add multiple policies with the same command. If
adding a single policy, you may use the combination of subject, object, action, and expression flags.
EXAMPLES
parsable-cli policies:add -t mikes-team --policy 'p,USER,ANALYTICS_2,role_admin,VIEW'
parsable-cli policies:add -t myteam --policy 'p,USER,ANALYTICS_2,role_admin,VIEW' --policy
'p,USER,ANALYTICS_2,role_admin,CREATE'
parsable-cli policies:add -t 42d2b7b8-1f8d-4dc7-8fcc-328dd3ac9e0b --subject USER --object TEAM_SETTINGS --action VIEW
--expression role_admin
See code: @wearableintelligence/plugin-admin-cli
List all team policies
USAGE
$ parsable-cli policies:list
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Retrieve a list of all policies for a team.
EXAMPLES
parsable-cli policies:list -t team-name
parsable-cli policies:list -t 95c9044c-39e9-42e2-93d0-4ba001981409
parsable-cli policies:list --team team-one
See code: @wearableintelligence/plugin-admin-cli
Setting Changes
USAGE
$ parsable-cli settings:audit
OPTIONS
-s, --settingId=settingId Setting ID
DESCRIPTION
...
See all changes made for a specific feature flag or parameter
ALIASES
$ parsable-cli settings:changes
EXAMPLES
parsable-cli settings:audit -s abac
parsable-cli settings:audit -s analyticsR2
parsable-cli settings:audit -s attributeOrdering
See code: @wearableintelligence/plugin-admin-cli
List settings for a team
USAGE
$ parsable-cli settings:list
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to view feature flags and parameters for a team
ALIASES
$ parsable-cli settings:ls
EXAMPLES
parsable-cli settings:list
parsable-cli settings:ls
parsable-cli settings:list --filter='type=Feature Flag'
parsable-cli settings:list --sort=-type
See code: @wearableintelligence/plugin-admin-cli
Update Team Settings
USAGE
$ parsable-cli settings:update
OPTIONS
-V, --value=value Update setting with this value
-d, --disable Disable a feature flag
-e, --enable Enable a feature flag
-m, --commit-msg=commit-msg [default: Updated via parsable-cli] Summarize your changes
-s, --settingId=settingId (required) Setting ID
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to toggle feature flags or update parameters for a team
EXAMPLES
parsable-cli settings:update -s workflow --disable
parsable-cli settings:update -s locale -V en-US
parsable-cli settings:update -t shell -s multiPhoto -V true
parsable-cli settings:update -t shell -s multiPhoto --enable -m 'Turning multi photo on for Shell'
See code: @wearableintelligence/plugin-admin-cli
Setting Rule Versions
USAGE
$ parsable-cli settings:versions
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
This command will provide a change log of any feature flags or parameter changes on a team
EXAMPLES
parsable-cli settings:versions
parsable-cli settings:versions -t honeywell
parsable-cli settings:versions -t halliburton -x
See code: @wearableintelligence/plugin-admin-cli
Create a new Parsable team
USAGE
$ parsable-cli teams:create
OPTIONS
-n, --name=name (required) The team display name
-r, --region=us-west-2|eu-west-1 The region the team resides in
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to create a new Parsable team. You will be the owner of the team and will be able to invite others to
it.
EXAMPLES
parsable-cli teams:create -n 'New Team'
parsable-cli teams:create -n 'My New Team' -r us-west-2
parsable-cli teams:create --name 'The Newest Team' --region eu-west-1
See code: @wearableintelligence/plugin-admin-cli
Delete a Parsable team and all related data
USAGE
$ parsable-cli teams:delete
OPTIONS
-f, --force Delete the team without confirmation prompt
-t, --team=team (required) Team ID or subdomain the request is for
DESCRIPTION
...
Use this command cautiously, this cannot be undone. All team data will be deleted from Parsable and cannot be
recovered.
EXAMPLES
parsable-cli teams:delete -t 07fd7d69-52b8-4375-a1a0-ce1a0788fd45
parsable-cli teams:delete --team e6cdd62d-36e0-43ba-9df0-c7bbdde28584
See code: @wearableintelligence/plugin-admin-cli
Disable a Parsable team
USAGE
$ parsable-cli teams:disable
OPTIONS
-t, --team=team (required) Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to disable a team. Once a team is disabled, it can no longer be accessed until enabled again.
EXAMPLES
parsable-cli teams:disable -t test-team
parsable-cli teams:disable -t cbc2141b-b084-4f8f-944a-d4349ae244e7
parsable-cli teams:disable --team 45d94ba2-439c-4398-a2b9-767a55dc3b30
See code: @wearableintelligence/plugin-admin-cli
Enable a Parsable team
USAGE
$ parsable-cli teams:enable
OPTIONS
-t, --team=team (required) Team ID the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
This command will enable a team that has been disabled. Team ID must be passed in, this will not work with only
passing in the subdomain.
EXAMPLES
parsable-cli teams:enable -t 79b4d6b5-8ad5-43a1-a37b-a8d0089d2fca
parsable-cli teams:enable --teamId 6625c0c1-8b8c-4f5b-a78d-89b94471ce69
See code: @wearableintelligence/plugin-admin-cli
Fetch a team
USAGE
$ parsable-cli teams:fetch
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Fetch a team by Team ID or Subdomain
ALIASES
$ parsable-cli teams:get
$ parsable-cli teams:show
$ parsable-cli teams:info
EXAMPLES
parsable-cli teams:fetch -t purple-monkeys
parsable-cli teams:fetch -t 767d94cd-2c48-455a-9da3-7f608c51f5f5
See code: @wearableintelligence/plugin-admin-cli
Lists all teams you have access to
USAGE
$ parsable-cli teams:list
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
This command will list all teams that your logged in user has access to.
ALIASES
$ parsable-cli teams:ls
EXAMPLES
parsable-cli teams:list
parsable-cli teams:ls
See code: @wearableintelligence/plugin-admin-cli
Provision a trial team
USAGE
$ parsable-cli teams:provision-trial
OPTIONS
-e, --email=email (required) The email of the trial user
-r, --region=region The region the team resides in (us-west-2|eu-west-1)
-t, --team-name=team-name (required) The name of the team for the trial user
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Sends a request to provision a trial team.
EXAMPLE
parsable-cli teams:provision-trial -e=test@email.com -r=us-west-2 -t='The Trial Team'
See code: @wearableintelligence/plugin-admin-cli
Update a Parsable team
USAGE
$ parsable-cli teams:update
OPTIONS
-T, --trial=on|off Turn on/off trial status for a team
-d, --disable Disable a team
-e, --enable Enable a team
-n, --name=name The team display name
-s, --subdomain=subdomain The team subdomain
-t, --team=team (required) Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to update a team. The team name, subdomain, and trial status may be updated. You may also enable or
disable a team.
ALIASES
$ parsable-cli teams:edit
EXAMPLES
parsable-cli teams:update -t my-team -n new-team-name -s new-subdomain
parsable-cli teams:update --team my-team --name just-another-team
parsable-cli teams:update -t my-team --disable
parsable-cli teams:update -t 1d0fef4c-3d7b-4315-bced-3cf5d0cd25ef --enable
parsable-cli teams:update -t my-team --trial off
parsable-cli teams:update -t dd9761cb-0b67-4085-952e-f532b8b4500b --trial on
See code: @wearableintelligence/plugin-admin-cli
Send request to copy templates.
USAGE
$ parsable-cli template:copy
OPTIONS
-x, --extended
show extra columns
--columns=columns
only show provided columns (comma-separated)
--config=config
Path to config json file.
Config json file should be in the following format:
{
"templateIds": [<string>],
"referenceSheetSetIds": [<string>],
"source": {
"teamId": <string>,
"email": <string>,
"password": <string>,
"apiBase": <string>
},
"destination": {
"teamId": <string>,
"email": <string>,
"password": <string>,
"apiBase": <string>
},
"options": {
"includeApplets": <boolean>,
"includeMetadata": <boolean>,
"includeProcedureTypes": <boolean>,
"includeInputTriggers": <boolean>,
"includeRefSheets": <boolean>
}
"shouldPublishTemplates": <boolean>
}
--csv
output is csv format [alias: --output=csv]
--dest-api-base=dest-api-base
hostname of the destination team environment
--dest-email=dest-email
email of admin user in the destination team
--dest-password=dest-password
password of admin user in the destination team
--dest-team-id=dest-team-id
destination team id for template(s) to copy into
--filter=filter
filter property by partial string matching, ex: name=foo
--include-applets
copy applets over
--include-input-triggers
copy input triggers over
--include-metadata
copy metadata over
--include-procedure-types
copy procedure types over
--include-refsheets
copy reference sheets over
--no-header
hide table header from output
--no-truncate
do not truncate output to fit screen
--output=csv|json|yaml
output in a more machine friendly format
--reference-sheet-set-ids=reference-sheet-set-ids
reference sheet set id(s) from source team to copy to destination team (comma-separated)
--should-publish-templates
copied templates should be published
--sort=sort
property to sort by (prepend '-' for descending)
--src-api-base=src-api-base
hostname of the source team environment
--src-email=src-email
email of admin user in the source team
--src-password=src-password
password of admin user in the source team
--src-team-id=src-team-id
source team id of template(s) to copy from
--template-ids=template-ids
template id(s) from source team to copy to destination team (comma-separated)
DESCRIPTION
Templates arrive at the destination team in Editing (draft) status.
We do not support copying archived templates.
Status report id will be returned unless the request takes over 30 seconds.
Requests that take over 30 seconds will cause the command to timeout.
This does not mean the request failed.
You can still check the statuses by template id: `parsable-cli template:copy:request --template-id <template_id>`
Please use 'parsable-cli login' to specify which environment (staging vs production) to run this command against.
Reference sheets are automatically copied over if they are associated with the template. Please make sure to include
the reference sheet id in the referenceSheetIds config so that templates with reference sheets are copied over
correctly.
Additional Notes:
* If you try to copy an object and it has attribute values, then the attribute values only copy over if the
destination
team has custom policies on. Otherwise, for destination teams with custom policies off, we do not copy attribute
values
* Metadata = parameters at the Template level. We do not copy anything Job related (job parameters).
We copy template metadata values if includeMetadata option is added and if the destination team has the exact
metadata value matches available.
EXAMPLES
parsable-cli template:copy
parsable-cli template:copy --config ./config.json
parsable-cli template:copy --should-publish-templates
parsable-cli template:copy --template-ids <template_id>,<template_id>
See code: @wearableintelligence/plugin-author-cli
Get the statuses for template copy requests.
USAGE
$ parsable-cli template:copy:status
OPTIONS
-s, --status-report-id=status-report-id get statuses for this status report id (id found in output of `parsable-cli
template:copy`)
-t, --template-id=template-id get statuses for this template id
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
There is one status per template copied.
Status fields returned include:
template_id, status (FAILED, SUCCESS, IN_PROGRESS, SCHEDULED), result, start_timestamp, end_timestamp, src_team_id,
dest_team_id
Please use 'parsable-cli login' to specify which environment (staging vs production) to run this command against.
EXAMPLES
parsable-cli template:copy:status
parsable-cli template:copy:status --status-report-id <status_report_id>
parsable-cli template:copy:status -s <status_report_id>
parsable-cli template:copy:status --template-id <template_id>
parsable-cli template:copy:status -t <template_id>
parsable-cli template:copy:status --output json
parsable-cli template:copy:status --filter status=FAILED
See code: @wearableintelligence/plugin-author-cli
update the parsable-cli CLI
USAGE
$ parsable-cli update [CHANNEL]
See code: @oclif/plugin-update
Add a user to a team
USAGE
$ parsable-cli users:add
OPTIONS
-P, --password=password
-e, --email=email
Email address of user
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-u, --username=username
Username or user id
--mail
Set flag to invite user by mail
DESCRIPTION
...
Use the password flag to create a user with a temporary password.
IMPORTANT - you can only create a temporary password if the user is not already a Parsable user, if the user has
already been created in Parsable the password will be ignored.
Set --mail flag to invite the user by email. You must be on the team to invite the user by mail.
EXAMPLES
parsable-cli users:add -t yara -u lwhittle -e lw@parsable.com -r PARSABLE_ADMIN -r ADMIN -r AUTHOR
parsable-cli users:add -u bgaffney -e bg@parsable.com -r PARSABLE_ADMIN -r ADMIN -P Pass1234!
parsable-cli users:add -e jd@parsable.com -r PARSABLE_ADMIN -r ADMIN --mail
See code: @wearableintelligence/plugin-admin-cli
Apply attributes to a user
USAGE
$ parsable-cli users:apply
OPTIONS
-a, --attributes=attributes Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Adds the attribute and attributes values to a user. This command is additive.
Attribute values are separated by |
Roles cannot be applied here, you must use the users:assign command to add Roles.
ALIASES
$ parsable-cli users:applyAttributes
EXAMPLE
parsable-cli users:apply -t onboarding -u lw@parsable.com -a 'Location=San Francisco|Austin' -a 'Business
Unit=Chicken|Kombucha'
See code: @wearableintelligence/plugin-admin-cli
Assign team roles to a user
USAGE
$ parsable-cli users:assign
OPTIONS
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-u, --username=username
Username or user id
DESCRIPTION
...
Adds team roles to a user. This command is additive.
ALIASES
$ parsable-cli users:assignRoles
EXAMPLES
parsable-cli users:assign -t onboarding -u lw@parsable.com -r ADMIN -r PARSABLE_ADMIN
parsable-cli users:assign -u afb7b786-fddd-4a5e-9df3-a44eba144b85 -t heineken -r EXECUTOR
See code: @wearableintelligence/plugin-admin-cli
Update users in bulk from a CSV
USAGE
$ parsable-cli users:bulk:update
OPTIONS
-f, --file=file (required) Path to the CSV file
DESCRIPTION
...
The CSV MUST have a header row that includes columns "id", "name", and "email".
The "id" and "name" are required, "email" is optional.
Save the CSV to your hard drive, then pass the path to the CSV with the --file flag
Example CSV
id, name, email
12c31f28-2f14-4c13-a6e4-90129ec96833, George Foreman, gforeman@parsable.com
b6e7596f-1178-435b-ad3e-d06f7fda87e9, Mike Tyson, mtyson@parsable.com
EXAMPLES
parsable-cli users:bulk:update -f input/updateUsers.csv
parsable-cli users:bulk:update -f /Users/username/parsable/update.csv
See code: @wearableintelligence/plugin-admin-cli
Deletes a user from a team
USAGE
$ parsable-cli users:delete
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
DESCRIPTION
...
WARNING: This command will completely delete a user from the team and remove all of their roles and attributes.
They will not show in the archived users list.
See code: @wearableintelligence/plugin-admin-cli
Grants a user a persistent auth token
USAGE
$ parsable-cli users:grant
OPTIONS
-u, --username=username (required) Username or user id
DESCRIPTION
...
Creates a persistent auth token for a user. A user can only have one persistent auth token at any given time.
EXAMPLES
parsable-cli users:grant -u john.doe@parsable.com
parsable-cli users:grant -u afb7b786-fddd-4a5e-9df3-a44eba144b85
See code: @wearableintelligence/plugin-admin-cli
Lists users on a team
USAGE
$ parsable-cli users:list
OPTIONS
-a, --attributes=attributes
Attribute and attribute values, formatted like key=value|value|value
-p, --paging=paging
Paging for querying, in the format {page}:{limit}. The limit is the number of results per page and the page is how
many pages to “skip” over before starting to return results.
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-x, --extended
show extra columns
--all
Set flag to list all users on the team
--columns=columns
only show provided columns (comma-separated)
--csv
output is csv format [alias: --output=csv]
--filter=filter
filter property by partial string matching, ex: name=foo
--no-header
hide table header from output
--no-truncate
do not truncate output to fit screen
--output=csv|json|yaml
output in a more machine friendly format
--sort=sort
property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to query users on a team by roles and attributes. Supports paging.
ALIASES
$ parsable-cli users:ls
EXAMPLES
parsable-cli users:list -t halliburton
parsable-cli users:list -t d364a4aa-ef06-4848-9af3-ad1bf6f01dc7
parsable-cli users:list -t corteva -r EXECUTOR
parsable-cli users:list -t afb7b786-fddd-4a5e-9df3-a44eba144b85 -a Role=AUTHOR
parsable-cli users:list -t afb7b786-fddd-4a5e-9df3-a44eba144b85 -r PARSABLE_ADMIN -a Location=Austin
parsable-cli users:list -t afb7b786-fddd-4a5e-9df3-a44eba144b85 --all
See code: @wearableintelligence/plugin-admin-cli
Query for users across teams or within a specific team
USAGE
$ parsable-cli users:query
OPTIONS
-n, --name=name (required) Name or partial name to query
-t, --team=team Leave blank to query across all teams, add to query within a specific team
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Enter a name or partial name to query across all teams, or add the team flag to query within a specific team
ALIASES
$ parsable-cli users:find
EXAMPLES
parsable-cli users:query -n mike
parsable-cli users:query --name michael
parsable-cli users:query -n michael -t the-a-team
See code: @wearableintelligence/plugin-admin-cli
Removes a user from a team
USAGE
$ parsable-cli users:remove
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
DESCRIPTION
...
This command removes all roles for a user on a given team.
ALIASES
$ parsable-cli users:removeUserFromTeam
$ parsable-cli users:rm
EXAMPLES
parsable-cli users:remove -t halliburton -u jane@parsable.com
parsable-cli users:remove -t d364a4aa-ef06-4848-9af3-ad1bf6f01dc7 -u c08a5391-3798-469c-a156-8bd333a54db0
parsable-cli users:rm -u john@parsable.com -t 2bf8a711-1404-4467-9fe7-ead62b5f04ea
See code: @wearableintelligence/plugin-admin-cli
Revoke a persistent auth token
USAGE
$ parsable-cli users:revoke
OPTIONS
-u, --username=username (required) Username or user id
DESCRIPTION
...
Revokes a persistent auth token for a user. The persistent auth token will no longer by valid to use.
EXAMPLES
parsable-cli users:revoke -u lisa@parsable.com
parsable-cli users:revoke -u d364a4aa-ef06-4848-9af3-ad1bf6f01dc7
See code: @wearableintelligence/plugin-admin-cli
Show user information
USAGE
$ parsable-cli users:show
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-u, --username=username Username or user id
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Use this command to view a specific user's information
ALIASES
$ parsable-cli users:get
$ parsable-cli users:fetch
EXAMPLES
parsable-cli users:show -u bob@parsable.com
parsable-cli users:show -u bfd373c2-efe5-4251-a81e-c16d63f01377
parsable-cli users:show -u chai@parsable.com -t wacker
parsable-cli users:show -u test.user@sera.co -t d364a4aa-ef06-4848-9af3-ad1bf6f01dc7
See code: @wearableintelligence/plugin-admin-cli
View team tokens
USAGE
$ parsable-cli users:tokens
OPTIONS
-t, --team=team Team ID or subdomain the request is for
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Lists all auth tokens granted to users on a team
EXAMPLES
parsable-cli users:tokens -t c53149e5-931a-48b8-9f2a-9f079d47e3cc
parsable-cli users:tokens -t heineken
See code: @wearableintelligence/plugin-admin-cli
Remove attributes on a user
USAGE
$ parsable-cli users:unapply
OPTIONS
-a, --attributes=attributes Attribute and attribute values, formatted like key=value|value|value
-t, --team=team Team ID or subdomain the request is for
-u, --username=username (required) Username or user id
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Removes the attributes values applied a user.
Attribute values are separated by |
Roles cannot be applied here, you must use the users:unassign command to remove Roles.
ALIASES
$ parsable-cli users:unapplyAttributes
EXAMPLE
parsable-cli users:unapply -t onboarding -u lw@parsable.com -a 'Location=San Francisco|Austin' -a 'Business
Unit=Chicken|Kombucha'
See code: @wearableintelligence/plugin-admin-cli
Remove team roles from a user
USAGE
$ parsable-cli users:unassign
OPTIONS
-r,
--roles=ADMIN|AUTHOR|JOBCREATOR|EXECUTOR|PARSABLE_ADMIN|WORKFLOW_PLANNER|ANALYTICS_EDITOR|ANALYTICS_VIEWER|IT_ADMIN
Team roles
-t, --team=team
Team ID or subdomain the request is for
-u, --username=username
Username or user id
DESCRIPTION
...
Removes team roles from a user.
ALIASES
$ parsable-cli users:unassignRoles
EXAMPLES
parsable-cli users:unassign -t onboarding -u lw@parsable.com -r ADMIN -r PARSABLE_ADMIN
parsable-cli users:unassign -u afb7b786-fddd-4a5e-9df3-a44eba144b85 -t heineken -r EXECUTOR
See code: @wearableintelligence/plugin-admin-cli
Update the name or email of a user
USAGE
$ parsable-cli users:update
OPTIONS
-U, --userId=userId (required) User id
-e, --email=email Email address of user
-n, --name=name (required) Name
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
...
Update the name or email of a user. Name changes will be applied instantly.
Email changes will need to be accepted by the user, an email will be sent to their old email address to confirm.
To update a user, you must either have an ADMIN role on a shared team or have Parsable super admin privileges.
The userId flag is required to update a user along with name, email is optional.
EXAMPLES
parsable-cli users:update -U d364a4aa-ef06-4848-9af3-ad1bf6f01dc7 -n 'Jonathan Doe' -e 'j.doe@hotmail.com'
parsable-cli users:update -U d364a4aa-ef06-4848-9af3-ad1bf6f01dc7 -n 'John Doe'
See code: @wearableintelligence/plugin-admin-cli
=======
Command Line Tools for the Parsable PaaS