> ## Documentation Index
> Fetch the complete documentation index at: https://www.landbase.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# onboarding

> Read and fill in the active account's onboarding profile from the CLI

Read the active account's onboarding profile and fill it in. The profile is
organized into three sections — `aboutCompany`, `aboutAudience`, and
`aboutCompetition` — that describe your company, your target audience, and your
competition.

<Note>
  `onboarding` is a **platform-mode** command. Run
  [`landbase-cli auth login`](/docs/reference/auth) and then
  [`landbase-cli account set`](/docs/reference/account) first — without an active
  account the command exits with `No account id...`. You can also pass
  `--account=<id>` per call.
</Note>

## onboarding get

Print the current profile plus a per-field schema describing each question, its
type, whether it's required, whether it's filled, and its current value. Run this
first to see which fields still need answers.

**Usage**

```bash theme={null}
landbase-cli onboarding get
```

Prints `{ accountId, sections, schema }`. See
[output schemas](/docs/reference/output-schemas#onboarding-get).

***

## onboarding update

Submit a partial onboarding payload as JSON. The platform merges your payload
with the current state, so you can update a single field without resending the
whole section. Pass `-` to read the body from stdin.

**Usage**

```bash theme={null}
landbase-cli onboarding update --json <path|->
```

<ParamField path="--json" type="string" required>
  Path to a JSON file containing the payload, or `-` to read it from stdin. At
  least one of `aboutCompany`, `aboutAudience`, or `aboutCompetition` is required.
</ParamField>

<Warning>
  **Partial-merge trap.** `aboutCompany` and `aboutCompetition` are
  partial-mergeable — send only the fields you're changing. `aboutAudience` must
  be a **complete** segment: include every required audience field in one
  payload, or the platform rejects it. Field types, the complete schema, and the
  clear-a-field rules are documented in
  [output schemas](/docs/reference/output-schemas#onboarding-update).
</Warning>

**Flags**

| Flag             | Default | Description                                      |
| ---------------- | ------- | ------------------------------------------------ |
| `--account=<id>` | —       | Override the active account for a single command |
| `--verbose`      | —       | Print request/response details to stderr         |

**Examples**

```bash theme={null}
# Inspect what still needs answers
landbase-cli onboarding get

# Update a single company field from stdin
echo '{"aboutCompany":{"description":"We sell AI-powered prospecting tools."}}' \
  | landbase-cli onboarding update --json -

# Update from a file
landbase-cli onboarding update --json ./onboarding.json
```

## Errors

| Code            | Meaning                                                                                                                               |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `INVALID_INPUT` | The validator rejected the body — read the message. A body of `[null]` signals a nested validation error on a recently-touched field. |
| `AUTH_REQUIRED` | Run `landbase-cli auth login` first (browser-interactive).                                                                            |
| `AUTH_FAILED`   | The platform session expired (7-day TTL) — re-login.                                                                                  |
| `NOT_FOUND`     | The account id is not a membership of the current user. Use `account list` to confirm valid ids.                                      |

## Related

* [How to select and onboard an account](/docs/how-to/select-and-onboard-account)
* [account command reference](/docs/reference/account)
* [Output schemas](/docs/reference/output-schemas#onboarding-get)
* [Error codes](/docs/reference/error-codes)