Installation
Adding Waypost takes only a few deliberate steps.
Adding Waypost to your app
Install the package with npm install @waypost/client or pnpm add @waypost/client. This adds the client library, which still needs to be initialized near your application entry point.
Initialize Waypost as early as practical so the launcher is ready when your interface becomes interactive:
import { init } from '@waypost/client'; init({ projectKey: 'wp_live_c8f21' });
Starting Waypost
No Waypost interface appears until the client has a signed-in user. Calling start makes tools available while keeping them scoped to the current session.
The client API is available through your imported instance. A useful place to start it is immediately after authentication succeeds:
const userKey = 'member_8174'; waypost.start({ userKey }); // Tools are now available for this session
The user key should be unique and pseudonymous. It connects interaction events to one account without exposing a person’s name or email.
Optional properties such as surface and workspace may also be supplied to start. Read the client API reference for the complete shape.
Opening Waypost
Once initialized and started, the launcher can be opened with ⌘ K on macOS or Ctrl K elsewhere. Relevant guides and checklists may also appear when their targeting rules are met.
Opening the studio
The Waypost studio is where your team manages actions, guides, and search sources. You can open it in either of two ways:
- Choose Studio from the workspace navigation.
- Open the launcher, type
open studio, and press return.