Last updated

Getting started — the whole journey

Mirrored from iblai/vibe · docs/getting-started.md. This page is generated — edit it in the repository, not here.

The README gives you the three steps. This page is what actually happens in each, which entry point is yours, and what to do when you are not starting from scratch.

Which entry point is yours

You areArchitectureEntry point
Starting a new app for one organization — yours, or a customer you deploy to (most apps)single-org: the org key is pinned, one server-to-server token, members sign in with SSO/iblai-vibe-start → /iblai-vibe-ops-init copies vibe-starter
Building one deployment for many organizations, users moving between them (the os.ibl.ai model)multi-org: org in the URL, a switcher, re-auth per org/iblai-vibe-start → /iblai-vibe-ops-init, then /iblai-vibe-auth → "Going multi-org"
Adding ibl.ai to an existing Next.js appeither of the above/iblai-vibe-start → /iblai-vibe-auth, then the feature skills
Adding ibl.ai to an existing app that is not Next.jseither/iblai-vibe-start → /iblai-api-login; the iblai-api-* skills work anywhere, the components need Next.js
Writing a script, CI job, or backend — nobody signs inheadless: a Platform API Token per org/iblai-vibe-start → /iblai-api-login, then the iblai-api-* skill for the family

How sign-in and organizations really work: auth-model.md. The data every app is built on: domain-model.md.

The journey

  1. Get an organization — sign up at ibl.ai/join; it creates your account and your organization. (Everyone is also in the shared main org — that one is not yours.) → Platform lifecycle
  2. Get two values — your org key (on login.iblai.app/me) and a Platform API Token (os.ibl.ai → Admin → Integrations → APIs → Add API). → same doc
  3. Scaffold and run — install the skills, run /iblai-vibe-ops-init, pnpm dev, sign in, pick or create your agent on /setup.
  4. Add the core — profile, admin area, custom user and org data, memory, analytics, notifications: one skill each, below.
  5. Make it yours — your pages with shadcn/ui; anything without a component through the REST API (/iblai-vibe-api).
  6. Charge (optional) — /iblai-vibe-pricing: how you are billed, and the three ways to bill your users.
  7. Ship — /iblai-vibe-ops-deploy for a URL; /iblai-vibe-ops-build and /iblai-vibe-ops-release for desktop, mobile, and the stores.

Every step in detail, with what to click and what to check: platform-lifecycle.md.

Connecting your organization

/iblai-vibe-connect opens login.iblai.app/connect: you sign in (or create an organization), pick the organization, click Connect, and the agent receives the org key, your username, and a fresh Platform API Token on a loopback callback — it writes iblai.env, .env, and .env.local and never shows the token. No browser (SSH, a container)? The same page has a manual mode you paste into the chat. Until the hosted page ships, the skills fall back to asking for the two values and telling you exactly where they are: connect-flow.md.

The core app

What /iblai-vibe-ops-init gives you, and the skill that owns each piece. ★ marks the six core data families almost every app reads or writes (which scope stores what) — each links its headless twin, the iblai-api-* skill that documents the same data over REST.

You getSkillReads / writes on the platform
SSO sign-in, session, org resolution (a placeholder or main org shows an alert, not a login loop)/iblai-vibe-authlogin
Home = chat with your agent — streaming, files, voice, canvas/iblai-vibe-agent-chat (+ sidebar, projects)agent-session
Agents browser (favorites, featured, custom, all)/iblai-vibe-agent-searchsearch
★ Create an agent from the app; set its identity, visibility, capabilities; every settings tab/iblai-vibe-agent-create, /iblai-vibe-agent-setting, /iblai-vibe-agent★ agent-setting
★ The user's profile — name, bio, image, education, résumé/iblai-vibe-profile★ profile
★ Custom data per user — preferences, flags, onboarding, app state (no DB, no localStorage)/iblai-vibe-user-metadata★ profile-metadata
★ Custom data per organization — settings, name, logos, support email/iblai-vibe-org-metadata, /iblai-vibe-account★ org
Users vs admins — User/Admin view switch, admin area, invites, roles and policies/iblai-vibe-admin, /iblai-vibe-invite, /iblai-vibe-rbacmanagement, rbac, invite
★ Memory — what agents remember about people (user-global, per agent, agent knowledge)/iblai-vibe-memory-guide, /iblai-vibe-memory, /iblai-vibe-agent-memory★ agent-memory
★ Analytics — usage, users, topics, transcripts, costs, audit, reports; org-wide or per agent/iblai-vibe-analytics, /iblai-vibe-agent-audit, /iblai-vibe-history★ analytics
Notifications — bell, inbox, alerts, admin send/iblai-vibe-notificationnotification
Navbar, onboarding flow, README/iblai-vibe-navbar, /iblai-vibe-onboard, /iblai-vibe-readme—
Anything with no component/iblai-vibe-apiany of the 51 iblai-api-* skills
Test before showing work (build, tests, a browser touch test); keep current/iblai-vibe-ops-test, /iblai-vibe-ops-upgrade—

How money works

Two families of skills, one install

Every skill carries a kind in its frontmatter (ui, api, guide, ops, security — docs/skill-kinds.md). The name prefix tells you the family; the kind tells you whether there is a screen.

iblai-vibe-* — build (has a screen)iblai-api-* — operate (no screen)
What it doesMounts an SDK visual component in your Next.js app — a page, a tab, a dialog, a widgetDrives the platform headlessly: exact REST endpoints (method, URL, body, errors), curl first
Who it is forBuilders shipping an appAnyone operating an organization — from a terminal, a script, CI, a server route, or an agent
CredentialsThe signed-in user's session in the browser; IBLAI_API_KEY only in server routesIBLAI_API_KEY (Platform API Token) as Authorization: Api-Token, from .env or iblai.env
Start/iblai-vibe → /iblai-vibe-ops-init/iblai-api-login
Alsoguide (indexes and decision pages), ops (build, deploy, test, release), securityTutorials in tutorials/; the hosted chat MCP server in mcp/

Builders use both: the ui skill mounts the component, its Platform data table names the api twin for anything the component doesn't cover, and /iblai-vibe-api is the server-route pattern that joins them. The iblai-api-* family is the former iblai/api repository, merged here with its authoring contract intact — docs/api-skills.md.

Headless API skills (kind: api)

Connect once with /iblai-api-login (org key, username, Platform API Token → .env + iblai.env), then any skill below is a / command that calls https://api.iblai.app with Authorization: Api-Token.

AreaSkills
Setup/iblai-api-login (start with /iblai-vibe-start if you have not)
One agent (★ = the families most apps read or write)★ agent-setting, ★ agent-memory, agent-create, agent-prompt, agent-llm, agent-dataset, agent-tool, agent-access, agent-embed, agent-mcp, agent-safety, agent-privacy, agent-disclaimer, agent-history, agent-audit, agent-eval, agent-skill, agent-sandbox, agent-support
Talk to an agentagent-session (REST/SSE/WebSocket), agent-chat (hosted MCP server), inference (OpenAI-compatible /v1)
Organization★ org, management, rbac, invite, scim, token, integration, notification, feature, billing, spend-caps, crm, external-service-proxy
The signed-in user★ profile, ★ profile-metadata
Content, discovery, analytics★ analytics, search, catalog, catalog-media, catalog-invitation, milestone, credential, apply
Other LMSscanvas-course-builder (Canvas REST API)
Guides (no endpoints)ecosystem, infrastructure (self-hosting)

Every name above is /iblai-api-<name>.

The full, tiered catalogue with one-line descriptions is in CLAUDE.md. Skills are in skills/; npx skills add installs them into your project's .claude/skills/. Read them, extend them, or write your own — the front door for agents is /iblai-vibe.

The ibl.ai backend

https://api.iblai.app powers every vibe app; you build, host, and maintain no backend services. It provides SSO (OAuth/OIDC/SAML) with multi-org isolation and RBAC; agents with streaming, tools, RAG, memory, voice, and any LLM; analytics; notifications; per-user and per-org metadata; credits, spend caps, and Stripe billing. In the browser the SDK sends the signed-in user's session token; your server holds one org-scoped Platform API Token in the gitignored iblai.env / .env.local. How that fits together: docs/security-model.md.

Two MCP servers

@iblai/mcp — SDK documentation for your coding assistant (components, hooks, RTK Query endpoints, provider setup). .mcp.json at the project root (vibe-starter ships it):

{
  "mcpServers": {
    "iblai": { "command": "pnpm", "args": ["dlx", "@iblai/mcp"] }
  }
}

(npx -y @iblai/mcp in npm projects.) It gives your assistant get_component_info, get_hook_info, get_api_query_info, get_provider_setup, create_page_template, get_playwright_helper_info.

iblai-agent-chat — a hosted MCP server for the one runtime capability that is not a REST call: holding a live conversation with a deployed agent (streamed responses, tool use, RAG). No install; wire it with /iblai-api-agent-chat or by hand from mcp/iblai-agent-chat/README.md:

claude mcp add iblai-agent-chat --transport http https://asgi.data.iblai.app/mcp/agent-chat/ \
  --header "Authorization: Api-Token YOUR_API_TOKEN" --header "X-Mentor-Unique-Id: YOUR_AGENT_UUID"

Copyright © ibl.ai | support@iblai.zendesk.com