Skip to main content

# kater init guide

Prints the guide that an agent follows to set up Kater for an admin, or to set up a Developer's own computer.

{/* 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. */}

Give it to Claude Code, Codex or another agent that runs commands in your shell. It does not sign you in, and it changes nothing.

## Examples

```bash
# Print the guide for every step of the setup
kater init guide
# Print the guide for drafting the company description with the admin
kater init guide about
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<topic>` | Optional. `about` prints the guide for drafting the company description with the admin. Leave it out to print the guide for every step. |

</div>

## Options

It also takes `--help`.

## What the guide tells an agent

- The guide names each step's command, the questions to ask you, and the rules to follow.
- The agent never asks for a password, a passphrase or the content of a key. You type a secret in a page in your browser.
- The agent asks you before each choice. These are the schemas, profiling, the people to invite and their role, the repository, `--takeover` and a reset.
- When a step fails, the agent runs it one more time. When it fails again, the agent stops and gives you the error.

## See also

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

On this page

Examples
Arguments
Options
What the guide tells an agent
See also

Kater CLI Set up init

kater init guide

Prints the guide that an agent follows to set up Kater for an admin, or to set up a Developer's own computer.

Give it to Claude Code, Codex or another agent that runs commands in your shell. It does not sign you in, and it changes nothing.

Examples

# Print the guide for every step of the setup
kater init guide
# Print the guide for drafting the company description with the admin
kater init guide about

Arguments

Argument	Description
`<topic>`	Optional. `about` prints the guide for drafting the company description with the admin. Leave it out to print the guide for every step.

Options

It also takes --help.

What the guide tells an agent

The guide names each step’s command, the questions to ask you, and the rules to follow.
The agent never asks for a password, a passphrase or the content of a key. You type a secret in a page in your browser.
The agent asks you before each choice. These are the schemas, profiling, the people to invite and their role, the repository, --takeover and a reset.
When a step fails, the agent runs it one more time. When it fails again, the agent stops and gives you the error.

See also