Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ git clone https://github.com/basefoundry/base.git
git clone https://github.com/basefoundry/base-demo.git
```

For a first Base setup, `basectl onboard base-demo` is the recommended guided path.
It wraps the setup, profile, doctor, and project-discovery flow for new Base
users. Run `basectl onboard base-demo --dry-run` to preview the steps without
changing local state.

From the `base-demo` repository root on a machine where Base is already set up:

```bash
Expand Down
15 changes: 15 additions & 0 deletions tests/validate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,21 @@ grep -Fq 'basectl setup base-demo # macOS only' README.md || {
exit 1
}

grep -Fq 'basectl onboard base-demo' README.md || {
printf 'README.md does not document basectl onboard in Quick Start.\n' >&2
exit 1
}

grep -Fq 'basectl onboard base-demo --dry-run' README.md || {
printf 'README.md does not document basectl onboard --dry-run in Quick Start.\n' >&2
exit 1
}

grep -Fq 'recommended guided path' README.md || {
printf 'README.md does not describe basectl onboard as the recommended guided path.\n' >&2
exit 1
}

grep -Fq 'basectl activate base-demo # macOS only' README.md || {
printf 'README.md does not annotate activate as macOS-only in Quick Start.\n' >&2
exit 1
Expand Down
Loading