> For the complete documentation index, see [llms.txt](https://docs-lunar.earthly.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-lunar.earthly.dev/plugin-sdks/bash-sdk/cataloger.md). # Cataloger The Cataloger Bash SDK is a set of Lunar CLI subcommands that allow you to save catalog-related information from within a cataloger. ## Cataloger environment Earthly Lunar executes catalogers in an environment set up with the following variables: * `LUNAR_HUB_HOST`: The host of the Lunar Hub. * `LUNAR_HUB_INSECURE`: Whether to skip SSL verification of the Lunar Hub. * `LUNAR_BIN_DIR`: The directory where the Lunar CLI is installed. * `LUNAR_CATALOGER_NAME`: The name of the cataloger. 🚧 Coming Soon * `LUNAR_CATALOGER_OWNER`: The owner of the cataloger. 🚧 Coming Soon * `LUNAR_SECRET_`: Any secret set in the Lunar Hub for the cataloger, via `HUB_CATALOGER_SECRETS=NAME:VALUE,NAME2:VALUE2`. * `LUNAR_COMPONENT_ID`: The ID of the component that the cataloger is running for in `github.com/.../...` format. Only set for `component-repo` and `component-cron` hooks. ## `lunar catalog` CLI command * Forms: * Raw form: ```bash lunar catalog raw [--json] ``` * Component form:

Coming Soon — This feature is not yet available.

```bash lunar catalog component [--name ] [--owner ] [--branch ] [--domain ] [--tag ] [--ci-pipeline ] [--meta =] [--meta-json =] [] ``` * Domain form:

Coming Soon — This feature is not yet available.

\`\`\`bash lunar catalog domain \[--name ] \[--description ] \[--owner ] \[--meta =] \[--meta-json =] \[] \`\`\` The `lunar catalog` command is used to save catalog-related information from within a cataloger. The command takes a JSON path and a value as arguments. The JSON path is used to specify the location in the JSON object where the value should be stored. ### `--json` The `--json` flag is used to specify that the value should be interpreted as a JSON object, JSON array, or JSON scalar (string, number, etc). If the flag is not provided, the value is interpreted as a raw string. ### `` * Type: `string` The JSON path is used to specify the location in the JSON object where the value should be stored. The path is specified using dot notation, where each level of the object is separated by a dot. For example, `.foo.bar.baz` would specify the `baz` property of the `bar` object, which is a property of the `foo` object. ### `` By default, the value is interpreted as a raw string. If the `--json` flag is provided, the value is interpreted as a JSON object, JSON array, or JSON scalar (string, number, etc). If the value is `-`, the value is read from standard input. This is useful for piping the output of a command into the `lunar catalog` command. ### `--name ` * Type: `string` * Optional The `--name` flag is used to specify the name of the component or domain. When using the `component-repo` or `component-cron` cataloger hooks, the name of the component and the domain will be inferred automatically from the cataloger context in which the command is executed (`LUNAR_COMPONENT_ID` is set for both hooks). In Component and Domain forms, the name must be provided either via this flag, via the cataloger context (`component-repo` and `component-cron` hooks), or via the JSON value. ### `--owner ` * Type: `string` * Optional The `--owner` flag is used to specify the owner of the component or domain. ### `--branch ` * Type: `string` * Optional The `--branch` flag is used to specify the branch of the component. ### `--domain ` * Type: `string` * Optional The `--domain` flag is used to specify the domain of the component. The domain must be specified in the format `foo.bar`, where `foo` is the parent domain and `bar` is the child domain. ### `--tag ` * Type: `string` * Optional The `--tag` flag is used to specify the tag of the component. This flag may be specified multiple times to add multiple tags to the component. ### `--ci-pipeline ` * Type: `string` * Optional The `--ci-pipeline` flag is used to specify the CI pipeline of the component. This flag may be specified multiple times to add multiple CI pipelines to the component. ### `--meta =` * Type: `string` * Optional The `--meta` flag is used to specify a metadata key-value pair for the component or domain. This flag may be specified multiple times to add multiple metadata entries. The value is interpreted as a raw string. ### `--meta-json =` * Type: `string` * Optional The `--meta-json` flag is used to specify a metadata key-value pair for the component or domain where the value is interpreted as JSON. This flag may be specified multiple times to add multiple metadata entries. The value must be valid JSON (object, array, or scalar). ### `--description ` * Type: `string` * Optional The `--description` flag is used to specify the description of the domain. ### `` * Type: `JSON string` * Optional The JSON value is used to specify the value to be stored in the JSON object. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs-lunar.earthly.dev/plugin-sdks/bash-sdk/cataloger.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.