Skip to main content

# kater init about

Writes the company description, which each person's agent reads before it answers.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

This is step 5 of [`kater init`](https://kater.ai/docs/cli-reference/init/). Draft the description with an agent first: `kater init guide about` tells it how.

## Examples

```bash
# Write the company description, with the organisation's name as the company
kater init about --business "Runs paid ads on Google, Facebook and TikTok, and tracks site visits in GA4." --audience "The marketing team, who decide where the ad budget goes." --question "Which platform gets the most conversions for its spend?" --question "How did spend change last month?"
# Replace a description that already has text
kater init about --company acme --business "Runs paid ads on Google, Facebook and TikTok." --audience "The marketing team." --question "Which platform gets the most conversions for its spend?" --replace
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--company <name>` | The company's name. Leave it out to use the organisation's name. |
| `--business <text>` | What the business does, in two or three sentences. By default it is empty. |
| `--audience <text>` | Who uses the company's data, and what they decide with it. By default it is empty. |
| `--question <text>` | A question or a metric that matters to the business. Kater keeps the first 10. You can give it more than one time. |
| `--replace` | Replaces a description that already has text. Without it, the command stops when the description has text. |

</div>

It also takes `--help`.

## When a description is there

- Without `--replace`, the command stops with the code `description_exists`.
- Run `kater init tables` to read the saved text, and start from it.
- You can run this command again at any time, such as after a schema sync adds tables. The progress of the setup does not change.

## What goes in it

Kater saves the description as the `about.md` at the root of your content. Do not put a person's name, email address or other personal data in it. The step needs the first query step first. It needs the `settings:manage` permission.

## See also

- [`kater init`](https://kater.ai/docs/cli-reference/init/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Options
When a description is there
What goes in it
See also

Kater CLI Set up init

kater init about

Writes the company description, which each person's agent reads before it answers.

This is step 5 of kater init. Draft the description with an agent first: kater init guide about tells it how.

Examples

# Write the company description, with the organisation's name as the company
kater init about --business "Runs paid ads on Google, Facebook and TikTok, and tracks site visits in GA4." --audience "The marketing team, who decide where the ad budget goes." --question "Which platform gets the most conversions for its spend?" --question "How did spend change last month?"
# Replace a description that already has text
kater init about --company acme --business "Runs paid ads on Google, Facebook and TikTok." --audience "The marketing team." --question "Which platform gets the most conversions for its spend?" --replace

Options

Option	Description
`--company <name>`	The company’s name. Leave it out to use the organisation’s name.
`--business <text>`	What the business does, in two or three sentences. By default it is empty.
`--audience <text>`	Who uses the company’s data, and what they decide with it. By default it is empty.
`--question <text>`	A question or a metric that matters to the business. Kater keeps the first 10. You can give it more than one time.
`--replace`	Replaces a description that already has text. Without it, the command stops when the description has text.

It also takes --help.

When a description is there

Without --replace, the command stops with the code description_exists.
Run kater init tables to read the saved text, and start from it.
You can run this command again at any time, such as after a schema sync adds tables. The progress of the setup does not change.

What goes in it

Kater saves the description as the about.md at the root of your content. Do not put a person’s name, email address or other personal data in it. The step needs the first query step first. It needs the settings:manage permission.

See also