← All extensions
Onboarding banner

Onboarding

ivyx✓

A short tour of each window the first time it opens, and a way to see it again

Onboarding

The first time a window opens on this machine it explains itself: a short introduction over the Welcome screen, then a tour that points at each panel once a folder is open. Both can be shown again at any time.

What you can do

  • Read a four-card introduction the first time Studio opens, before any folder is chosen
  • Take a tour of the Studio window the first time it opens on a workspace: files, search, Git, the agent, models, the terminal, extensions, the Ivy Marketplace and settings
  • Take a tour of the Agent window and of the Learn window, each the first time it opens
  • Move with Next, Back and Skip, or with the arrow keys and Escape
  • Run Onboarding: Show the tour from the command palette to see the tour of the window you are in again
  • Run Onboarding: Show the introduction to read the cards again
  • Run Onboarding: Forget what was shown so every window introduces itself again next time

Notes and limits

  • What was shown is remembered per machine, not per folder, so opening a second project does not repeat the tour
  • A tour step whose panel is not in the window right now is skipped, and a tour that finds nothing to point at is shown again next time
  • Nothing leaves your machine: the extension has no network access and reads no files

Getting started

Open a folder from the Welcome screen and the tour starts on its own. To see it later, open the command palette and run Onboarding: Show the tour.