Packages

Manage packages.

Usage:

shell

humioctl packages [command]

Use humioctl packages [command] --help for more information about a command.

Table: Packages commands

Parameter	Description
`Archive`	Create a zip file containing the content of a package directory.
`Install`	Install a package.
`List installed`	List all installed packages in a repository.
`Uninstall`	Uninstall a package.
`Validate`	Validate a package's content.

Table: Local flags

Parameter	Description
`-h, --help`	Help for packages

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Parameter	Description
`-h, --help`	Help for archive

Install

Install a package from a directory, a zip file, a GitHub repository URL, or a zip file URL, for example:

shell

humioctl packages install myrepo /path/to/package/dir/ --queryOwnership organization
humioctl packages install myrepo /path/to/package.zip --queryOwnership user
humioctl packages install myrepo https://github.com/org/mypackage-name --queryOwnership organization
humioctl packages install myrepo https://content.example.com/mypackage-name.zip --queryOwnership user

Usage:

shell

humioctl packages install <repo-or-view> <path-to-package-dir> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for install
`-q, --queryOwnership organization`	The query ownership of installed queries, for example in triggers. Possible values: `organization` or `user`. Default: `user`.

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

List installed

List all installed packages in a repository or view.

Usage:

shell

humioctl packages list-installed <repo-or-view> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for list-installed

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Uninstall

Uninstall a package.

Usage:

shell

humioctl packages uninstall <repo-or-view> <package> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for uninstall

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Validate

Validate a package from a directory or zip file against a repository or view, for example:

shell

humioctl packages validate myrepo /path/to/package/dir/
humioctl packages validate myrepo /path/to/package.zip

Usage:

shell

humioctl packages validate <repo-or-view> <package-dir-or-zip> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for validate

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Versions of this Page

Command line tools and scripts

Command-Line Interface (humioctl)

Packages

Archive

Install

List installed

Uninstall

Validate

Enter search term