kxi package
Insights Package Building CLI.
Usage:
text
kxi package [OPTIONS] COMMAND [ARGS]...
Options:
text
--version Show the version and exit.
--artifact-store DIRECTORY
--pkg-lib DIRECTORY
--debug Enable stacktrace print statements and increase
verbosity for easier debugging.
-v, --verbose Increase verbosity level
-q, --quiet Disable logs. Only print errors.
--stacktrace Enable stacktrace print statements.
--help Show this message and exit.
kxi package add
Add an entity to the specified package.
Usage:
text
kxi package add [OPTIONS] COMMAND [ARGS]...
Options:
text
--to <Package> Package, to which, the entity will be added.
--help Show this message and exit.
kxi package add agg
Add aggregator to the specified package
Usage:
text
kxi package add agg [OPTIONS]
Options:
text
--help Show this message and exit.
kxi package add database
Add a database to the specified package.
Usage:
text
kxi package add database [OPTIONS]
Options:
text
--name TEXT Name of the database to be added to the package.
--help Show this message and exit.
kxi package add dep
Add a package dependency to the specified package.
Usage:
text
kxi package add dep [OPTIONS]
Options:
text
--name TEXT Name of the dependent package.
--version TEXT Version of the dependent package.
--repo TEXT Repository of the dependent package if it is a remote
package.
--location TEXT Location of the dependent package - "local" or "remote".
--path TEXT Path to the dependent package if it is a local package.
--help Show this message and exit.
kxi package add deployment-config
Add deployment_config to the specified package
Usage:
text
kxi package add deployment-config [OPTIONS]
Options:
text
--name TEXT Name of the deployment_config to add to the package
--help Show this message and exit.
kxi package add entrypoint
Add an entrypoint to the specified package.
Usage:
text
kxi package add entrypoint [OPTIONS]
Options:
text
--name TEXT Name of the entrypoint to add from the package.
--path PATH Path to the entrypoint.
--help Show this message and exit.
kxi package add patch
Add patch to the specified package
Usage:
text
kxi package add patch [OPTIONS]
Options:
text
--dep TEXT Name of the dependency where the patch is located
--name TEXT Name of the patch to add to the package
--help Show this message and exit.
kxi package add pipeline
Add a pipeline to the specified package.
Usage:
text
kxi package add pipeline [OPTIONS]
Options:
text
--name TEXT Name of the pipeline to be added to the package.
--replicas INTEGER Number of replica pipelines to create.
--spec-file TEXT Source file for pipeline to use
--base [q|py|q-ml|py-ml] Base image to deploy, one of q, py, q-ml or py-ml
--help Show this message and exit.
kxi package add rc
Add resource coordinator to the specified package
Usage:
text
kxi package add rc [OPTIONS]
Options:
text
--help Show this message and exit.
kxi package add router
Add a router to the specified package.
Usage:
text
kxi package add router [OPTIONS]
Options:
text
--name TEXT Name of the router to add from the package.
--help Show this message and exit.
kxi package add shard
Same as add database.
Usage:
text
kxi package add shard [OPTIONS]
Options:
text
--name TEXT Name of the shard to be added to the database.
--help Show this message and exit.
kxi package add stream
Add a stream to the specified database.
Usage:
text
kxi package add stream [OPTIONS]
Options:
text
--name TEXT Name of the stream to be added to the database.
--database TEXT Name of the database to add the stream to.
--external BOOLEAN Flag for internally or externally facing Sequencer.
--sub-topic TEXT Name of the subtopic for the external stream.
--help Show this message and exit.
kxi package add table
Add a table to the specified package.
Usage:
text
kxi package add table [OPTIONS]
Options:
text
--name TEXT Name of the table to be added to the package. [default:
mytable]
--help Show this message and exit.
kxi package add view
Add a view to the specified package.
Usage:
text
kxi package add view [OPTIONS]
Options:
text
--name TEXT Name of the view to add to the package.
--data TEXT Add data from an existing json file to the view
--help Show this message and exit.
kxi package checkpoint
Update the package version given a source code directory.
Usage:
text
kxi package checkpoint [OPTIONS] SOURCE
Options:
text
--version TEXT Override the version of the package.
--bump [major|minor|patch|dev] Increment the major/minor/patch/dev version.
--version-info TEXT Leave a description note for the checkpoint
version.
--package-name TEXT Override the auto-generated package name.
--kxi TEXT Create a kxi artifact after checkpointing in
a target directory.
--help Show this message and exit.
kxi package config
Local configuration options.
Usage:
text
kxi package config [OPTIONS] COMMAND [ARGS]...
Options:
text
--help Show this message and exit.
kxi package config get
Get package configuration.
Usage:
text
kxi package config get [OPTIONS] [OPTION]...
Options:
text
-p, --with-profile Include KXI Profile Info
-o, --output [table|json|yaml] Output format
--help Show this message and exit.
kxi package config set
Set package configuration values (envvars) only
Usage:
text
kxi package config set [OPTIONS] OPTION VALUE
Options:
text
--help Show this message and exit.
kxi package convert
Convert Assembly to Package and vice versa.
Depending on what object the filepath points to:
text
If file contains assembly: Convert an asm -> package
If dir contains Package:
If Convert package to -> yaml/json (e.g. --fmt json)
Usage:
text
kxi package convert [OPTIONS] FILEPATH
Options:
text
--spec-files This flag converts embedded pipeline specs to files
--help Show this message and exit.
kxi package copy
Copy an entity from the specified package.
Usage:
text
kxi package copy [OPTIONS] COMMAND [ARGS]...
Options:
text
-f, --from <Src-Package> Package from which the entity will be copied.
-t, --to <Target-Package> Package to which the entity will be
copied;[default] `from`.
--help Show this message and exit.
kxi package copy pipeline
Copy a pipeline from the specified package.
Note: This operation will clobber existing pipelines.
Usage:
text
kxi package copy pipeline [OPTIONS]
Options:
text
--src-name TEXT Name of the pipeline to copy.
--dest-name TEXT Name of the newly copied pipeline.
--replicas INTEGER Number of replica pipelines to create.
--help Show this message and exit.
kxi package deploy
Deploy a package to an insights instance.
text
SOURCE: package-name[/version]
Consider using kxi pm deploy instead.
Usage:
text
kxi package deploy [OPTIONS] [EXTRA_ARGS]... SOURCE
Options:
text
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--db TEXT Deploy an existing package's database (must
be defined in the package)
--pipeline TEXT Deploy an existing package's pipeline (must
be defined in the package)
--rm-existing-data Remove the data associated with the old
deployment
--env TEXT Inject environment variables to the deployed
package. `[component_name:]VAR=value`
--help Show this message and exit.
kxi package field
Find, list or mutate fields within a package.
Usage:
text
kxi package field [OPTIONS] COMMAND [ARGS]...
Options:
text
--help Show this message and exit.
kxi package field find
Find an object inside a package by looking up it's type (e.g Table). Case sensitive.
Usage:
text
kxi package field find [OPTIONS] [PACKAGE_PATH] [CLASSNAME]
Options:
text
-f, --filter TEXT Key-value pair to filter the returned objects on.
--help Show this message and exit.
kxi package field get
Get a json representation of a field at a location using dot notation e.g. ".pipelines[0].name".
Usage:
text
kxi package field get [OPTIONS] [REQUIREMENT_SPECIFIER] [PATH]
Options:
text
--help Show this message and exit.
kxi package field info
Print out the information about the object specified. Case sensitive.
Usage:
text
kxi package field info [OPTIONS] CLASSNAME
Options:
text
--show-defaults Show default values for fields if present.
--help Show this message and exit.
kxi package field set
Set a field using dot notation path e.g.".pipelines[0].name". Can only set strings curently
Usage:
text
kxi package field set [OPTIONS] [REQUIREMENT_SPECIFIER] PATH VALUE
Options:
text
--help Show this message and exit.
kxi package info
show some info about the package
Usage:
text
kxi package info [OPTIONS] [REQUIREMENT_SPECIFIER]
Options:
text
-i, --include [udfs|policies] Include additional information in the
output.
-o, --output-format [json|table]
Output format for the list command
--help Show this message and exit.
kxi package init
Creates a bare package at the specified target path.
Note: this will not be saved to your KX_PACKAGE_PATH unless install is explicitly run.
Usage:
text
kxi package init [OPTIONS] [PATH_TO_PACKAGE]
Options:
text
--force Force initialisation: overwrite existing directory if one
already exists.
--reset Reset initialisation: overwrite the existing manifest only
--version TEXT Version of the package to initialise.
--help Show this message and exit.
kxi package install
Install a package given a requirement or path.
Usage:
text
kxi package install [OPTIONS] [REQUIREMENT_SPECIFIER]
Options:
text
--override-deps TEXT Specify which deps to override during install. format
'name/ver:path/to/new/package'
--simple Simplify the output to name/version format.
--add-symlink-to PATH Create a symlink of package_name/version at the
specified directory.
--force Force install: overwrite existing packages and
dependencies.
--help Show this message and exit.
kxi package list
List all installed packages or artifacts.
Usage:
text
kxi package list [OPTIONS]
Options:
text
--obj-type TEXT List this obj type (e.g. Pipelines)
overrides artifact/deployment flag. Case
Sensitive.
--simple Simplify the output to one line format.
-f, --filter TEXT Key-value pair to filter the returned
packages on. Multiple conditions AND-ed
together.
--fields TEXT Specify the root level attrs as a comma
separated list, e.g. `name,version` or
specify `all` for all fields
--package-json List the full manifests for each package.
(Deprecated)
--artifacts List available artifacts on the system.
--deployments List deployments tracked from this client
-d, --dir PATH List objects in this directory
--in-pkg TEXT Look for the object inside a given pkg
[name/version].
-o, --output-format [json|simple|table]
Output format for the list command
--help Show this message and exit.
kxi package lock
Lock the q files within a source directory. Files whose first line is /dnc or //dnc will be ignored.
Usage:
text
kxi package lock [OPTIONS] SOURCE
Options:
text
--keep-unlocked Keep the original unlocked q files once the locked versions
are created.
--help Show this message and exit.
kxi package overlay
Overlay a package using a spec file containing a subset of fields.
Usage:
text
kxi package overlay [OPTIONS] <Package> [OVERLAY_SPEC]...
Options:
text
--help Show this message and exit.
kxi package packit
Create a package artifact given a source code directory.
Usage:
text
kxi package packit [OPTIONS] SOURCE
Options:
text
--override-deps TEXT Specify which deps to override during packit. format
'name/ver:path/to/new/package'
--keep-unlocked Keep the original unlocked q files once the locked
versions are created.
--lock-q-files Lock the contents of the q files in the package. Files
whose first line is /dnc or //dnc will be ignored.
--all-deps Package all dependencies together.
--tag Tag for release, omit the random dev hash suffix.
--version TEXT Override the version of the package.
--package-name TEXT Override the auto-generated package name.
--help Show this message and exit.
kxi package pm
Insights Package Manager Service commands.
Usage:
text
kxi package pm [OPTIONS] COMMAND [ARGS]...
Options:
text
--version Display the version of the kdb+ Insights
Enterprise Package Manager service and
client.
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm backup
Download a backup of all entitled packages from kdb+ Insights Enterprise Package Manager service
Admin users can download all packages, while non-admin users can only download packages they have READ access to.
Usage:
text
kxi package pm backup [OPTIONS] [TARGET]
Options:
text
-o, --output-format [json|table]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm config
Server configuration options.
Usage:
text
kxi package pm config [OPTIONS] COMMAND [ARGS]...
Options:
text
--help Show this message and exit.
kxi package pm config get
Get the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm config get [OPTIONS]
Options:
text
-o, --output-format [json|table]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm config set
Set the current configuration of the kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm config set [OPTIONS] OPTION VALUE
Options:
text
-o, --output-format [json|table]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm convert
Convert V1/V2 assemblies into Packages with the server. Optionally keep the package installed on the server.
Usage:
text
kxi package pm convert [OPTIONS] ASSEMBLY_FILE
Options:
text
--install Additionally installs the resulting package
on the server.
-o, --output-format [json|table]
Output format for the list command
--spec-files This flag converts embedded pipeline specs
to files
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm deploy
Deploy a package to an insights instance.
PACKAGE: package-name VERSION: package-version
Usage:
text
kxi package pm deploy [OPTIONS] PACKAGE [VERSION]
Options:
text
--env TEXT Inject environment variables to the deployed
package. `[component_name:]VAR=value`
-o, --output-format [json|table]
Output format for the list command
--db TEXT Deploy a database in the package
--pipeline TEXT Deploy a pipeline in the package
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm edit
Edit the runnable component of the kdb+ Insights Enterprise Package on the service.
Usage:
text
kxi package pm edit [OPTIONS] PACKAGE_NAME {pipeline|database} COMPONENT_NAME
Options:
text
--field TEXT Only edit a specific field of the entity.
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm info
Get info about a package stored on the kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm info [OPTIONS] PACKAGE_NAME [VERSION]
Options:
text
-v, --version TEXT Select package version. Default to latest.
-i, --include [udfs|policies] Include additional information in the
output. Only applies when no component type
is given.
-o, --output-format [json|table]
Output format for the list command
-f, --filter TEXT Key-pattern pairs to filter the returned
components using case-sensitive wildcard
matching (e.g. name=*test). Multiple
patterns ANDed together. Only applies when
component type (e.g. table) is given.
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm list
List objects stored on kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm list [OPTIONS]
[[package|deployment|pipeline|view|database|udf]]
Options:
text
-f, --filter TEXT Key-pattern pair to filter the returned
packages on. Applies case-sensitive
filtering using wildcard patterns. Multiple
patterns ANDed together. Key names may
include dot notation for nested values
(e.g., owner.name=John*).
--fields TEXT [default: name, package, version, function,
status, data, access, owner, id, info]
-o, --output-format [json|table|csv|simple]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm pull
Download a package from kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm pull [OPTIONS] NAME [VERSION]
Options:
text
-O, --output TEXT Specify the output directory/archive name
for the downloaded package. Defaults to
package-name or packagename-version.kxi
-A, --artifact Download the package into a compressed
archive.
-o, --output-format [json|table]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm push
Publish a package to kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm push [OPTIONS] [PATH]
Options:
text
--deploy Deploy the package after pushing.
--force Force push: overwrite existing packages
-o, --output-format [json|table]
Output format for the list command
--lock-q-files Lock the contents of the q files in the
package. Files whose first line is /dnc or
//dnc will be ignored.
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm restore
Restore a previously downloaded backup to kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm restore [OPTIONS] [PATH]
Options:
text
--force Force restore: overwrite existing packages
-o, --output-format [json|table]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm rm
Remove a package from kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm rm [OPTIONS] ID [VERSION]
Options:
text
--teardown Teardown the package before removing.
--rm-data Remove the data associated with the
deployment
-o, --output-format [json|table]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm teardown
Teardown a deployed package running on an insights instance
Usage:
text
kxi package pm teardown [OPTIONS] PACKAGE
Options:
text
--rm-data Remove the data associated with the
deployment
-o, --output-format [json|table]
Output format for the list command
--db TEXT Teardown a database in the package
--pipeline TEXT Teardown a pipeline in the package
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pm validate
Validate a package in kdb+ Insights Enterprise Package Manager service.
Usage:
text
kxi package pm validate [OPTIONS] PACKAGE
Options:
text
-o, --output-format [json|table]
Output format for the validate command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package pull
text
Download an artifact from the running insights package manager service to your local directory.
Where NAMEVER is the 'name[/version]' of the artifact we want to pull from the service.
Consider using kxi pm pull instead.
Usage:
text
kxi package pull [OPTIONS] NAMEVER
Options:
text
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package push
text
Publish an artifact to the running insights package manager service.
Where ARTIFACT is either the filepath or the 'name/version' of the artifact.
Consider using kxi pm push instead.
Usage:
text
kxi package push [OPTIONS] ARTIFACT
Options:
text
--force Force push: overwrite existing packages and
their dependencies.
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package refresh
Refresh a package, picking up any available changes from disk
Usage:
text
kxi package refresh [OPTIONS] <Package>
Options:
text
--fix-uuids Fix names and uuids of duplicate objects in the package.
--fix-dupes Fix names and uuids of duplicate objects in the package.
--help Show this message and exit.
kxi package remote-config
text
Set a configuration option for the remote package manager.
Consider using kxi pm config instead.
Usage:
text
kxi package remote-config [OPTIONS] CONFIG
Options:
text
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package remote-convert
text
Convert V1/V2 assemblies into Packages with the server.
Optionally keep the package installed on the server.
Consider using kxi pm convert instead.
Usage:
text
kxi package remote-convert [OPTIONS] ASSEMBLY_FILE
Options:
text
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--install Additionally installs the resulting package
on the server.
--help Show this message and exit.
kxi package remote-list
List all installed packages or artifacts on the running insights package manager service.
Consider using kxi pm list instead.
Usage:
text
kxi package remote-list [OPTIONS]
Options:
text
--fields TEXT List only the specified fields.
-f, --filter TEXT Key value pair to filter on. In particular
name and version.
--deployments If passed, list available deployments on the
system.
--artifacts If passed, list available artifacts on the
system.
--simple Simplify the output to 'name/version'
format.
--obj-type [Package|Artifact|Stream|Database|Pipeline|Schema|Assembly|View]
List this obj type (e.g. Pipeline) overrides
artifact/deployment flag. Case Sensitive.
-o, --output-format [json|simple|table]
Output format for the list command
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package remote-remove
Remove packages or artifacts from the running insights package manager service.
Consider using kxi pm rm instead.
Usage:
text
kxi package remote-remove [OPTIONS] [OBJECTS]...
Options:
text
--artifacts Remove available artifacts rather than
installed packages.
--obj-type [Package|Artifact] Remove available object from system
--force Force remove: suppress the user confirmation
message during removal.
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--help Show this message and exit.
kxi package rm
Remove an entity from the specified package.
Usage:
text
kxi package rm [OPTIONS] COMMAND [ARGS]...
Options:
text
-f, --from <Package> Package from which the entity will be removed.
--help Show this message and exit.
kxi package rm agg
Remove aggregator from the specified package
Usage:
text
kxi package rm agg [OPTIONS]
Options:
text
--help Show this message and exit.
kxi package rm database
Remove a database from the specified package
Usage:
text
kxi package rm database [OPTIONS]
Options:
text
--name TEXT Name of the component to remove from the package.
--help Show this message and exit.
kxi package rm dep
Remove a dependency from the specified package.
Usage:
text
kxi package rm dep [OPTIONS]
Options:
text
--name TEXT Name of the dependency to remove from the package.
--version TEXT version of the dependency to remove from the package.
--help Show this message and exit.
kxi package rm deployment-config
Remove deployment_config from the specified package
Usage:
text
kxi package rm deployment-config [OPTIONS]
Options:
text
--help Show this message and exit.
kxi package rm entrypoint
Remove entrypoint from the specified package.
Usage:
text
kxi package rm entrypoint [OPTIONS]
Options:
text
--name TEXT Name of the entrypoint to remove from the package.
--help Show this message and exit.
kxi package rm patch
Remove patch from the specified package
Usage:
text
kxi package rm patch [OPTIONS]
Options:
text
--name TEXT Name of the patch to remove from the package.
--help Show this message and exit.
kxi package rm pipeline
Remove a pipeline from the specified package.
Usage:
text
kxi package rm pipeline [OPTIONS]
Options:
text
--name TEXT Name of the pipeline to remove from the package.
--help Show this message and exit.
kxi package rm rc
Remove resource_coordinator from the specified package
Usage:
text
kxi package rm rc [OPTIONS]
Options:
text
--help Show this message and exit.
kxi package rm router
Remove a router from the specified package.
Usage:
text
kxi package rm router [OPTIONS]
Options:
text
--help Show this message and exit.
kxi package rm shard
Use rm database instead.
Usage:
text
kxi package rm shard [OPTIONS]
Options:
text
--name TEXT Name of the shard to be removed.
--help Show this message and exit.
kxi package rm stream
Remove stream from the specified package
Usage:
text
kxi package rm stream [OPTIONS]
Options:
text
--name TEXT Name of the stream to be removed from the database.
--database TEXT Name of the database where the stream is located.
--help Show this message and exit.
kxi package rm table
Remove a table from the specified package
Usage:
text
kxi package rm table [OPTIONS]
Options:
text
--name TEXT Name of the table to remove from the package.
--help Show this message and exit.
kxi package rm view
Remove a view from the specified package.
Usage:
text
kxi package rm view [OPTIONS]
Options:
text
--name TEXT Name of the view to remove from the package.
--help Show this message and exit.
kxi package teardown
Teardown one or multiple deployed packages running on an insights instance.
Consider using kxi pm teardown instead.
Usage:
text
kxi package teardown [OPTIONS] [PACKAGE]...
Options:
text
--hostname, --url TEXT Insights URL
--realm TEXT Realm
--client-id TEXT Client id
--client-secret TEXT Client secret
--auth-enabled / --auth-disabled
Retrieve Bearer Token
--server-timeout INTEGER Timeout for Insights server calls
-y, --yes, --assume-yes Automatic yes to prompts; assume "yes" as
answer to all prompts and run non-
interactively.
--rm-data Remove the data associated with the
deployment
--help Show this message and exit.
kxi package uninstall
Uninstall specified locally installed packages and artifacts.
Usage:
text
kxi package uninstall [OPTIONS] [OBJECTS]...
Options:
text
--artifacts Remove available artifacts rather than
installed packages.
--obj-type [Package|Artifact|Deployment]
Remove available object from system
--force Force uninstall: suppress user confirmation
during removal.
--help Show this message and exit.
kxi package unpack
Unpack an artifact to a specified location.
Usage:
text
kxi package unpack [OPTIONS] ARTIFACT_PATH
Options:
text
--unpack-dir PATH Path to the directory where the artifact will be
unpacked to;[default] `.`.
--force Force unpack: Suppress user confirmation during removal
of existing package
--clear-target-dir Clear the target directory entirely before unpacking the
artifact. Destructive.
--help Show this message and exit.
kxi package validate
Validate the contents of a source directory to ensure it is a valid package.
Usage:
text
kxi package validate [OPTIONS] <Package>
Options:
text
--help Show this message and exit.