@contextual-io/cli
=================

Contextual CLI


* Usage
* Commands

Usage

``sh-session
$ npm install -g @contextual-io/cli
$ ctxl COMMAND
running command...
$ ctxl (--version)
@contextual-io/cli/0.6.0 linux-x64 node-v25.2.1
$ ctxl --help [COMMAND]
USAGE
$ ctxl COMMAND
...
`

Commands

* [ctxl autocomplete [SHELL]](#ctxl-autocomplete-shell)
* ctxl config
* ctxl config add CONFIG-ID
* ctxl config current
* ctxl config delete CONFIG-ID
* [ctxl config get [CONFIG-ID]](#ctxl-config-get-config-id)
* ctxl config list
* ctxl config login
* ctxl config use CONFIG-ID
* [ctxl help [COMMAND]](#ctxl-help-command)
* ctxl records
* [ctxl records add [URI]](#ctxl-records-add-uri)
* [ctxl records create [URI]](#ctxl-records-create-uri)
* [ctxl records delete [URI]](#ctxl-records-delete-uri)
* [ctxl records get [URI]](#ctxl-records-get-uri)
* [ctxl records import [URI]](#ctxl-records-import-uri)
* [ctxl records list [URI]](#ctxl-records-list-uri)
* [ctxl records patch [URI]](#ctxl-records-patch-uri)
* [ctxl records query [URI]](#ctxl-records-query-uri)
* [ctxl records remove [URI]](#ctxl-records-remove-uri)
* [ctxl records replace [URI]](#ctxl-records-replace-uri)
* [ctxl records rm [URI]](#ctxl-records-rm-uri)
* [ctxl records search [URI]](#ctxl-records-search-uri)
* [ctxl records stats [URI]](#ctxl-records-stats-uri)
* ctxl types
* ctxl types add
* ctxl types create
* [ctxl types delete [URI]](#ctxl-types-delete-uri)
* [ctxl types get [URI]](#ctxl-types-get-uri)
* ctxl types import
* ctxl types list
* [ctxl types remove [URI]](#ctxl-types-remove-uri)
* [ctxl types replace [URI]](#ctxl-types-replace-uri)
* [ctxl types rm [URI]](#ctxl-types-rm-uri)
* ctxl types search

ctxl autocomplete [SHELL]

Display autocomplete installation instructions.

`
USAGE
$ ctxl autocomplete [SHELL] [-r]

ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type

FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)

DESCRIPTION
Display autocomplete installation instructions.

EXAMPLES
$ ctxl autocomplete

$ ctxl autocomplete bash

$ ctxl autocomplete zsh

$ ctxl autocomplete powershell

$ ctxl autocomplete --refresh-cache
`

_See code: @oclif/plugin-autocomplete_

ctxl config

Manage configs.

`
USAGE
$ ctxl config

DESCRIPTION
Manage configs.
`

ctxl config add CONFIG-ID

Add a new config.

`
USAGE
$ ctxl config add CONFIG-ID [-t ]

ARGUMENTS
CONFIG-ID id of config

FLAGS
-t, --tenant-id= tenant id (if different from config id)

DESCRIPTION
Add a new config.

EXAMPLES
$ ctxl config add some-config-id --tenant-id my-tenant
`

ctxl config current

Get the current config.

`
USAGE
$ ctxl config current [--json]

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Get the current config.

EXAMPLES
$ ctxl config current
`

ctxl config delete CONFIG-ID

Delete a config.

`
USAGE
$ ctxl config delete CONFIG-ID

ARGUMENTS
CONFIG-ID id of config

DESCRIPTION
Delete a config.

EXAMPLES
$ ctxl config delete some-config-id
`

ctxl config get [CONFIG-ID]

Get a specific config.

`
USAGE
$ ctxl config get [CONFIG-ID] [--json]

ARGUMENTS
[CONFIG-ID] id of config

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Get a specific config.

EXAMPLES
$ ctxl config get

$ ctxl config get some-config-id
`

ctxl config list

List all available configs.

`
USAGE
$ ctxl config list [--json]

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
List all available configs.

EXAMPLES
$ ctxl config list
`

ctxl config login

Login using the current config.

`
USAGE
$ ctxl config login

DESCRIPTION
Login using the current config.

EXAMPLES
$ ctxl config login
`

ctxl config use CONFIG-ID

Use a config.

`
USAGE
$ ctxl config use CONFIG-ID

ARGUMENTS
CONFIG-ID id of config

DESCRIPTION
Use a config.

EXAMPLES
$ ctxl config use some-config-id
`

ctxl help [COMMAND]

Display help for ctxl.

`
USAGE
$ ctxl help [COMMAND...] [-n]

ARGUMENTS
[COMMAND...] Command to show help for.

FLAGS
-n, --nested-commands Include all nested commands in the output.

DESCRIPTION
Display help for ctxl.
`

_See code: @oclif/plugin-help_

ctxl records

Manage records.

`
USAGE
$ ctxl records

DESCRIPTION
Manage records.
`

ctxl records add [URI]

Create record(s).

`
USAGE
$ ctxl records add [URI] [-C ] [-i ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Create record(s).

ALIASES
$ ctxl records create
$ ctxl records import

EXAMPLES
$ ctxl records add native-object:my-type

$ ctxl records add --type my-type --input-file records.json
`

ctxl records create [URI]

Create record(s).

`
USAGE
$ ctxl records create [URI] [-C ] [-i ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Create record(s).

ALIASES
$ ctxl records create
$ ctxl records import

EXAMPLES
$ ctxl records create native-object:my-type

$ ctxl records create --type my-type --input-file records.json
`

ctxl records delete [URI]

Delete record(s).

`
USAGE
$ ctxl records delete [URI] [-C ] [-I ...] [-T ]

ARGUMENTS
[URI] uri of record

FLAGS
-I, --id=... id(s)
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Delete record(s).

ALIASES
$ ctxl records rm
$ ctxl records remove

EXAMPLES
$ ctxl records delete native-object:my-type/instance-1

$ ctxl records delete native-object:my-type --id instance-1

$ ctxl records delete native-object:my-type --id instance-1 --id instance-2

$ ctxl records delete --type my-type --id instance-1

$ ctxl records delete --type my-type --id instance-1 --id instance-2
`

ctxl records get [URI]

Get a record.

`
USAGE
$ ctxl records get [URI] [-C ] [-I ...] [-T ]

ARGUMENTS
[URI] uri of record

FLAGS
-I, --id=... id(s)
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Get a record.

EXAMPLES
$ ctxl records get native-object:my-type/instance-1

$ ctxl records get native-object:my-type --id instance-1

$ ctxl records get native-object:my-type --id instance-1 --id instance-2

$ ctxl records get --type my-type --id instance-1

$ ctxl records get --type my-type --id instance-1 --id instance-2
`

ctxl records import [URI]

Create record(s).

`
USAGE
$ ctxl records import [URI] [-C ] [-i ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Create record(s).

ALIASES
$ ctxl records create
$ ctxl records import

EXAMPLES
$ ctxl records import native-object:my-type

$ ctxl records import --type my-type --input-file records.json
`

ctxl records list [URI]

List records.

`
USAGE
$ ctxl records list [URI] [-C ] [-S ...] [-e] [-f ...] [--include-total] [-o ...]
[--page-size ] [--page-token ] [-p] [-s ...] [-t ...] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-S, --exact-search=... search fields exactly
-T, --type= type
-e, --export export data as JSONL
-f, --from=... search from
-o, --order-by=... order fields
-p, --progress show progress during export
-s, --search=... search fields
-t, --to=... search to
--include-total include total count
--page-size= number of records per page
--page-token= page token to fetch

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
List records.

ALIASES
$ ctxl records search

EXAMPLES
$ ctxl records list native-object:my-type

$ ctxl records list --type my-type

$ ctxl records list --type my-type --order-by field1:desc

$ ctxl records list --type my-type -s field1=value1 -s field2=value2 --include-total
`

ctxl records patch [URI]

Patch a record.

`
USAGE
$ ctxl records patch [URI] [-C ] [-a ...] [-I ] [-i ...] [-d ...] [-r
...] [-s ...] [-T ]

ARGUMENTS
[URI] uri of record

FLAGS
-I, --id= id
-T, --type= type
-a, --add=... add field
-d, --remove=... remove field
-i, --increment=... increment field
-r, --replace=... replace field
-s, --set=... set field

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Patch a record.

EXAMPLES
$ ctxl records patch native-object:my-type/instance-1 --set field1=value1

$ ctxl records patch native-object:my-type --id instance-1 --remove field2

$ ctxl records patch --type my-type --id instance-1 --increment field3=2
`

ctxl records query [URI]

Query records.

`
USAGE
$ ctxl records query [URI] [-C ] [-e] [--include-total] [-o ...] [--page-size ]
[--page-token ] [-p] [-q ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type
-e, --export export data as JSONL
-o, --order-by=... order fields
-p, --progress show progress during export
-q, --query-file= [default: -] file to read. can read stdin if value is '-'
--include-total include total count
--page-size= number of records per page
--page-token= page token to fetch

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Query records.

EXAMPLES
$ ctxl records query native-object:my-type

$ ctxl records query --type my-type --query-file query.json

$ ctxl records query --type my-type --order-by field1:desc --query-file query.json

$ ctxl records query --type my-type --include-total --query-file query.json
`

ctxl records remove [URI]

Delete record(s).

`
USAGE
$ ctxl records remove [URI] [-C ] [-I ...] [-T ]

ARGUMENTS
[URI] uri of record

FLAGS
-I, --id=... id(s)
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Delete record(s).

ALIASES
$ ctxl records rm
$ ctxl records remove

EXAMPLES
$ ctxl records remove native-object:my-type/instance-1

$ ctxl records remove native-object:my-type --id instance-1

$ ctxl records remove native-object:my-type --id instance-1 --id instance-2

$ ctxl records remove --type my-type --id instance-1

$ ctxl records remove --type my-type --id instance-1 --id instance-2
`

ctxl records replace [URI]

Replace a record.

`
USAGE
$ ctxl records replace [URI] [-C ] [-I ] [-i ] [-T ]

ARGUMENTS
[URI] uri of record

FLAGS
-I, --id= id
-T, --type= type
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Replace a record.

EXAMPLES
$ ctxl records replace native-object:my-type/instance-1 --input-file record.json

$ ctxl records replace native-object:my-type --id instance-1 --input-file record.json

$ ctxl records replace --type my-type --id instance-1 --input-file record.json
`

ctxl records rm [URI]

Delete record(s).

`
USAGE
$ ctxl records rm [URI] [-C ] [-I ...] [-T ]

ARGUMENTS
[URI] uri of record

FLAGS
-I, --id=... id(s)
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Delete record(s).

ALIASES
$ ctxl records rm
$ ctxl records remove

EXAMPLES
$ ctxl records rm native-object:my-type/instance-1

$ ctxl records rm native-object:my-type --id instance-1

$ ctxl records rm native-object:my-type --id instance-1 --id instance-2

$ ctxl records rm --type my-type --id instance-1

$ ctxl records rm --type my-type --id instance-1 --id instance-2
`

ctxl records search [URI]

List records.

`
USAGE
$ ctxl records search [URI] [-C ] [-S ...] [-e] [-f ...] [--include-total] [-o ...]
[--page-size ] [--page-token ] [-p] [-s ...] [-t ...] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-S, --exact-search=... search fields exactly
-T, --type= type
-e, --export export data as JSONL
-f, --from=... search from
-o, --order-by=... order fields
-p, --progress show progress during export
-s, --search=... search fields
-t, --to=... search to
--include-total include total count
--page-size= number of records per page
--page-token= page token to fetch

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
List records.

ALIASES
$ ctxl records search

EXAMPLES
$ ctxl records search native-object:my-type

$ ctxl records search --type my-type

$ ctxl records search --type my-type --order-by field1:desc

$ ctxl records search --type my-type -s field1=value1 -s field2=value2 --include-total
`

ctxl records stats [URI]

Get the stats of a record.

`
USAGE
$ ctxl records stats [URI] [-C ] [-I ] [-T ]

ARGUMENTS
[URI] uri of record

FLAGS
-I, --id= id
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Get the stats of a record.

EXAMPLES
$ ctxl records stats native-object:my-type/instance-1

$ ctxl records stats native-object:my-type --id instance-1

$ ctxl records stats --type my-type --id instance-1
`

ctxl types

Manage types.

`
USAGE
$ ctxl types

DESCRIPTION
Manage types.
`

ctxl types add

Create type(s).

`
USAGE
$ ctxl types add [-C ] [-i ]

FLAGS
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Create type(s).

ALIASES
$ ctxl types create
$ ctxl types import

EXAMPLES
$ ctxl types add

$ ctxl types add --input-file types.json
`

ctxl types create

Create type(s).

`
USAGE
$ ctxl types create [-C ] [-i ]

FLAGS
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Create type(s).

ALIASES
$ ctxl types create
$ ctxl types import

EXAMPLES
$ ctxl types create

$ ctxl types create --input-file types.json
`

ctxl types delete [URI]

Delete a type.

`
USAGE
$ ctxl types delete [URI] [-C ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Delete a type.

ALIASES
$ ctxl types rm
$ ctxl types remove

EXAMPLES
$ ctxl types delete native-object:my-type

$ ctxl types delete --type my-type
`

ctxl types get [URI]

Get a type.

`
USAGE
$ ctxl types get [URI] [-C ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Get a type.

EXAMPLES
$ ctxl types get native-object:my-type

$ ctxl types get --type my-type
`

ctxl types import

Create type(s).

`
USAGE
$ ctxl types import [-C ] [-i ]

FLAGS
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Create type(s).

ALIASES
$ ctxl types create
$ ctxl types import

EXAMPLES
$ ctxl types import

$ ctxl types import --input-file types.json
`

ctxl types list

List types.

`
USAGE
$ ctxl types list [-C ] [-S ...] [-e] [-f ...] [--include-total] [-o ...]
[--page-size ] [--page-token ] [-p] [-s ...] [-t ...]

FLAGS
-S, --exact-search=... search fields exactly
-e, --export export data as JSONL
-f, --from=... search from
-o, --order-by=... order fields
-p, --progress show progress during export
-s, --search=... search fields
-t, --to=... search to
--include-total include total count
--page-size= number of types per page
--page-token= page token to fetch

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
List types.

ALIASES
$ ctxl types search

EXAMPLES
$ ctxl types list

$ ctxl types list --order-by field1:desc

$ ctxl types list -s field1=value1 -s field2=value2 --include-total
`

ctxl types remove [URI]

Delete a type.

`
USAGE
$ ctxl types remove [URI] [-C ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Delete a type.

ALIASES
$ ctxl types rm
$ ctxl types remove

EXAMPLES
$ ctxl types remove native-object:my-type

$ ctxl types remove --type my-type
`

ctxl types replace [URI]

Replace a type.

`
USAGE
$ ctxl types replace [URI] [-C ] [-i ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type
-i, --input-file= [default: -] file to read. can read stdin if value is '-'

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Replace a type.

EXAMPLES
$ ctxl types replace native-object:my-type --input-file record.json

$ ctxl types replace --type my-type --input-file record.json
`

ctxl types rm [URI]

Delete a type.

`
USAGE
$ ctxl types rm [URI] [-C ] [-T ]

ARGUMENTS
[URI] uri of type

FLAGS
-T, --type= type

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
Delete a type.

ALIASES
$ ctxl types rm
$ ctxl types remove

EXAMPLES
$ ctxl types rm native-object:my-type

$ ctxl types rm --type my-type
`

ctxl types search

List types.

`
USAGE
$ ctxl types search [-C ] [-S ...] [-e] [-f ...] [--include-total] [-o ...]
[--page-size ] [--page-token ] [-p] [-s ...] [-t ...]

FLAGS
-S, --exact-search=... search fields exactly
-e, --export export data as JSONL
-f, --from=... search from
-o, --order-by=... order fields
-p, --progress show progress during export
-s, --search=... search fields
-t, --to=... search to
--include-total include total count
--page-size= number of types per page
--page-token= page token to fetch

GLOBAL FLAGS
-C, --config-id= Specify config id to use for call.

DESCRIPTION
List types.

ALIASES
$ ctxl types search

EXAMPLES
$ ctxl types search

$ ctxl types search --order-by field1:desc

$ ctxl types search -s field1=value1 -s field2=value2 --include-total
``