kimono
Command Line Tool for all things Kimono
Usage
$ npm install -g @kimonocloud/cli
$ kimono COMMAND
running command...
$ kimono (-v|--version|version)
@kimonocloud/cli/1.1.1 darwin-x64 node-v14.6.0
$ kimono --help [COMMAND]
USAGE
$ kimono COMMAND
...Commands
kimono autocomplete [SHELL]kimono configkimono help [COMMAND]kimono interop:clouds [CLOUD_ID]kimono interop:clouds:search [OBJECT_ID]kimono interop:courses:disablekimono interop:courses:listkimono interop:courses:setkimono interop:ingestions [OBJECT_ID]kimono interop:integrations [INTEGRATION_ID]kimono interop:tenants [TENANT_ID]kimono pluginskimono plugins:install PLUGIN...kimono plugins:link PLUGINkimono plugins:uninstall PLUGIN...kimono plugins:updatekimono rostering:courses [COURSE_ID]kimono rostering:orgs [ORG_ID]kimono rostering:persons [PERSON_ID]kimono rostering:schools [SCHOOL_ID]kimono rostering:sectionmemberships [MEMBERSHIP_ID]kimono rostering:sections [SECTION_ID]kimono rostering:sections:students [SECTION_ID]kimono rostering:students [STUDENT_ID]kimono rostering:students:sections [STUDENT_ID]kimono rostering:teachers [TEACHER_ID]kimono update [CHANNEL]
kimono autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ kimono autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ kimono autocomplete
$ kimono autocomplete bash
$ kimono autocomplete zsh
$ kimono autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
kimono config
Initialize and set Defaults for CLI Tool
USAGE
$ kimono config
See code: src/commands/config.ts
kimono help [COMMAND]
display help for kimono
USAGE
$ kimono help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
kimono interop:clouds [CLOUD_ID]
List your Interop Clouds or a Single Cloud [CLOUD_ID]
USAGE
$ kimono interop:clouds [CLOUD_ID]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-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)
See code: src/commands/interop/clouds.ts
kimono interop:clouds:search [OBJECT_ID]
List your Interop Clouds
USAGE
$ kimono interop:clouds:search [OBJECT_ID]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --name=name Search by Cloud Name
-u, --userdata=userdata Search by User Data
-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)
See code: src/commands/interop/clouds/search.ts
kimono interop:courses:disable
Disable Scoping for Courses
USAGE
$ kimono interop:courses:disable
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
--file=file The path to the csv input file
See code: src/commands/interop/courses/disable.ts
kimono interop:courses:list
List Course scopes for a Tenant
USAGE
$ kimono interop:courses:list
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
--file=file The path to the csv input file
See code: src/commands/interop/courses/list.ts
kimono interop:courses:set
Set Course scopes for a Tenant
USAGE
$ kimono interop:courses:set
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
--file=file The path to the csv input file
See code: src/commands/interop/courses/set.ts
kimono interop:ingestions [OBJECT_ID]
List a tenant's ingestions
USAGE
$ kimono interop:ingestions [OBJECT_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/interop/ingestions.ts
kimono interop:integrations [INTEGRATION_ID]
List your Integrations or a single integration [INTEGRATION_ID]
USAGE
$ kimono interop:integrations [INTEGRATION_ID]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-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)
See code: src/commands/interop/integrations.ts
kimono interop:tenants [TENANT_ID]
List your Interop Tenants
USAGE
$ kimono interop:tenants [TENANT_ID]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-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)
See code: src/commands/interop/tenants.ts
kimono plugins
list installed plugins
USAGE
$ kimono plugins
OPTIONS
--core show core plugins
EXAMPLE
$ kimono plugins
See code: @oclif/plugin-plugins
kimono plugins:install PLUGIN...
installs a plugin into the CLI
USAGE
$ kimono plugins:install PLUGIN...
ARGUMENTS
PLUGIN plugin to install
OPTIONS
-f, --force yarn install with force flag
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ kimono plugins:add
EXAMPLES
$ kimono plugins:install myplugin
$ kimono plugins:install https://github.com/someuser/someplugin
$ kimono plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
kimono plugins:link PLUGIN
links a plugin into the CLI for development
USAGE
$ kimono plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLE
$ kimono plugins:link myplugin
See code: @oclif/plugin-plugins
kimono plugins:uninstall PLUGIN...
removes a plugin from the CLI
USAGE
$ kimono plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ kimono plugins:unlink
$ kimono plugins:remove
See code: @oclif/plugin-plugins
kimono plugins:update
update installed plugins
USAGE
$ kimono plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
kimono rostering:courses [COURSE_ID]
Returns a list of courses from a tenant, or a single course [COURSE_ID]
USAGE
$ kimono rostering:courses [COURSE_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/courses.ts
kimono rostering:orgs [ORG_ID]
Returns a List of Orgs from the Tenant, a single org [ORG_ID]
USAGE
$ kimono rostering:orgs [ORG_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/orgs.ts
kimono rostering:persons [PERSON_ID]
Returns a list of Persons from the Tenant
USAGE
$ kimono rostering:persons [PERSON_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/persons.ts
kimono rostering:schools [SCHOOL_ID]
Returns a List of Schools from the Tenant
USAGE
$ kimono rostering:schools [SCHOOL_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/schools.ts
kimono rostering:sectionmemberships [MEMBERSHIP_ID]
Returns a list of Section Memberships from a tenant
USAGE
$ kimono rostering:sectionmemberships [MEMBERSHIP_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/sectionmemberships.ts
kimono rostering:sections [SECTION_ID]
Returns a list of Course Sections from a tenant
USAGE
$ kimono rostering:sections [SECTION_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/sections.ts
kimono rostering:sections:students [SECTION_ID]
Returns the List of Students within a Section
USAGE
$ kimono rostering:sections:students [SECTION_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/sections/students.ts
kimono rostering:students [STUDENT_ID]
Returns a List of Students from the Tenant
USAGE
$ kimono rostering:students [STUDENT_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/students.ts
kimono rostering:students:sections [STUDENT_ID]
Returns a List of Student's sections
USAGE
$ kimono rostering:students:sections [STUDENT_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/students/sections.ts
kimono rostering:teachers [TEACHER_ID]
Returns a List of Teachers from a Tenant
USAGE
$ kimono rostering:teachers [TEACHER_ID]
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV output, ex
column_header:mapping => 'firstName:first.name' || 'updated at:$sys.updated_at'
-h, --help show CLI help
-i, --clientId=clientId Client Id for OAuth2 Authentication
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The Id of the Kimono Tenant or Actor
-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)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after the provided date, ex,
2019-10-18
See code: src/commands/rostering/teachers.ts
kimono update [CHANNEL]
update the kimono CLI
USAGE
$ kimono update [CHANNEL]
See code: @oclif/plugin-update
kimono help [COMMAND]kimono interop:cloudskimono interop:clouds:searchkimono interop:ingestionskimono interop:ingestions:infokimono interop:integrationskimono interop:integrations:infokimono interop:tenantskimono interop:tenants:info [OBJECT]kimono pluginskimono plugins:install PLUGIN...kimono plugins:link PLUGINkimono plugins:uninstall PLUGIN...kimono plugins:updatekimono rostering:courseskimono rostering:courses:info [OBJECT]kimono rostering:orgskimono rostering:orgs:info [OBJECT]kimono rostering:personskimono rostering:persons:info [OBJECT]kimono rostering:schoolskimono rostering:schools:info [OBJECT]kimono rostering:sectionmembershipskimono rostering:sectionmemberships:info [OBJECT]kimono rostering:sectionskimono rostering:sections:info [OBJECT]kimono rostering:sections:students [OBJECT]kimono rostering:studentskimono rostering:students:info [OBJECT]kimono rostering:students:sections [OBJECT]kimono rostering:teacherskimono rostering:teachers:info [OBJECT]kimono update [CHANNEL]
kimono help [COMMAND]
display help for kimono
USAGE
$ kimono help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
kimono interop:clouds
List your Interop Clouds
USAGE
$ kimono interop:clouds
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/clouds.ts
kimono interop:clouds:search
List your Interop Clouds
USAGE
$ kimono interop:clouds:search
OPTIONS
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-f, --force
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --name=name Search by Cloud Name
-u, --userdata=userdata Search by User Data
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/clouds/search.ts
kimono interop:ingestions
List a tenant's ingestions
USAGE
$ kimono interop:ingestions
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/ingestions.ts
kimono interop:ingestions:info
Info about an ingestion
USAGE
$ kimono interop:ingestions:info
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-i, --ingestion=ingestion (required) The ID of the Ingestion
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant (required) The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/ingestions/info.ts
kimono interop:integrations
List your Integrations
USAGE
$ kimono interop:integrations
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/integrations.ts
kimono interop:integrations:info
Info about an Integration
USAGE
$ kimono interop:integrations:info
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-i, --integration=integration the Id of the integration
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/integrations/info.ts
kimono interop:tenants
List your Interop Tenants
USAGE
$ kimono interop:tenants
OPTIONS
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-f, --force
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/tenants.ts
kimono interop:tenants:info [OBJECT]
Get Info for a specific Interop Tenant
USAGE
$ kimono interop:tenants:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/interop/tenants/info.ts
kimono plugins
list installed plugins
USAGE
$ kimono plugins
OPTIONS
--core show core plugins
EXAMPLE
$ kimono plugins
See code: @oclif/plugin-plugins
kimono plugins:install PLUGIN...
installs a plugin into the CLI
USAGE
$ kimono plugins:install PLUGIN...
ARGUMENTS
PLUGIN plugin to install
OPTIONS
-f, --force yarn install with force flag
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ kimono plugins:add
EXAMPLES
$ kimono plugins:install myplugin
$ kimono plugins:install https://github.com/someuser/someplugin
$ kimono plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
kimono plugins:link PLUGIN
links a plugin into the CLI for development
USAGE
$ kimono plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLE
$ kimono plugins:link myplugin
See code: @oclif/plugin-plugins
kimono plugins:uninstall PLUGIN...
removes a plugin from the CLI
USAGE
$ kimono plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ kimono plugins:unlink
$ kimono plugins:remove
See code: @oclif/plugin-plugins
kimono plugins:update
update installed plugins
USAGE
$ kimono plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
kimono rostering:courses
Returns a list of courses from a tenant
USAGE
$ kimono rostering:courses
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/courses.ts
kimono rostering:courses:info [OBJECT]
Returns a single Course Object from a specific tenant
USAGE
$ kimono rostering:courses:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/courses/info.ts
kimono rostering:orgs
Returns a List of Orgs from the Tenant
USAGE
$ kimono rostering:orgs
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/orgs.ts
kimono rostering:orgs:info [OBJECT]
Returns a single Org Object from a specific tenant
USAGE
$ kimono rostering:orgs:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/orgs/info.ts
kimono rostering:persons
Returns a list of Persons from the Tenant
USAGE
$ kimono rostering:persons
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/persons.ts
kimono rostering:persons:info [OBJECT]
Returns a single Person Object from a specific tenant
USAGE
$ kimono rostering:persons:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/persons/info.ts
kimono rostering:schools
Returns a List of Schools from the Tenant
USAGE
$ kimono rostering:schools
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/schools.ts
kimono rostering:schools:info [OBJECT]
Returns a single School Object from a specific tenant
USAGE
$ kimono rostering:schools:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/schools/info.ts
kimono rostering:sectionmemberships
Returns a list of Section Memberships from a tenant
USAGE
$ kimono rostering:sectionmemberships
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/sectionmemberships.ts
kimono rostering:sectionmemberships:info [OBJECT]
Returns a single Enrollment Object from a specific tenant
USAGE
$ kimono rostering:sectionmemberships:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/sectionmemberships/info.ts
kimono rostering:sections
Returns a list of Course Sections from a tenant
USAGE
$ kimono rostering:sections
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant (required) The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/sections.ts
kimono rostering:sections:info [OBJECT]
Returns a single Course Section Object from a specific tenant
USAGE
$ kimono rostering:sections:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/sections/info.ts
kimono rostering:sections:students [OBJECT]
Returns the List of Students within a Section
USAGE
$ kimono rostering:sections:students [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/sections/students.ts
kimono rostering:students
Returns a List of Students from the Tenant
USAGE
$ kimono rostering:students
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/students.ts
kimono rostering:students:info [OBJECT]
Returns a single Student Object from a specific tenant
USAGE
$ kimono rostering:students:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/students/info.ts
kimono rostering:students:sections [OBJECT]
Returns a List of Student's sections
USAGE
$ kimono rostering:students:sections [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/students/sections.ts
kimono rostering:teachers
Returns a List of Teachers from a Tenant
USAGE
$ kimono rostering:teachers
OPTIONS
-A, --allData Retrieve all pages of Data
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/teachers.ts
kimono rostering:teachers:info [OBJECT]
Returns a single Teacher Object from a specific tenant
USAGE
$ kimono rostering:teachers:info [OBJECT]
OPTIONS
-C, --customHeaders=customHeaders Define an Array of custom mappings for Table and CSV
output, ex column_header:mapping =>
'firstName:first.name' || 'updated
at:$sys.updated_at'
-H, --apiHost=api.us2.kimonocloud.com|api.us2.kimonoplatform.com [default: api.us2.kimonocloud.com] Override the
Default Base API URL
-I, --clientId=clientId Client Id for OAuth2 Authentication
-h, --help show CLI help
-j, --json exports response data in json format
-k, --apiKey=apiKey API Key for Basic Auth
-l, --limit=limit [default: 25] Sets the object count limit
-n, --norollup Removes all rolled up data from Objects
-o, --object=object The Kimono ID of the object
-p, --page=page [default: 0] Sets the start page for List Api
-s, --clientSecret=clientSecret Client Secret for OAuth2 Authentication
-t, --tenant=tenant The ID of the Tenant
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format
--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
--sort=sort property to sort by (prepend '-' for descending)
--updatedSince=updatedSince Returns objects where the $sys.updated_at is after
the provided date, ex, 2019-10-18
--useLocal Connect to a local instance of Kimono [DEV Only]
See code: src/commands/rostering/teachers/info.ts
kimono update [CHANNEL]
update the kimono CLI
USAGE
$ kimono update [CHANNEL]
See code: @oclif/plugin-update