К основному содержанию
скилл CX Codex

knock-in-app-ui — скилл для Claude Code: in-app UI Knock

Скилл knock-in-app-ui ведёт агента по внедрению in-app UI Knock: выбор между feeds и guides, провайдеры в React, рендер гидов и отладка. Только React и @knocklabs/react.

MIT 158 установок ★ 1 обновлён 2026-10-21

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add knocklabs/skills --skill knock-in-app-ui -a claude-code
Открыть на GitHub

Что делает knock-in-app-ui

Скилл ведёт агента по внедрению in-app UI от Knock в веб-приложение. Внутри четыре файла правил: выбор между feeds и guides, настройка провайдеров в React, рендер гидов через хуки, отладка. Работает только с React и пакетом @knocklabs/react. Для Vue, Svelte, React Native или нативного мобильного SDK скилл велит остановиться и спросить, а не переносить React-правила на другой клиент.

Перед кодом агент проверяет авторизацию в Knock CLI: knock whoami, при ошибке knock login, затем knock environment list, и дальше передаёт --environment <env-slug> во все команды. channelId он находит сам через knock channel list --json. А публичный ключ pk_ из Platform → API keys и user.id из контекста авторизации приложения придётся дать вручную.

Потом поднимает KnockProvider и KnockGuideProvider, привязывает readyToTarget к асинхронным данным и строит первый компонент по реальному гиду из knock guide list. Кастомный компонент сам вызывает markAsSeen, markAsInteracted и markAsArchived. Гид не рендерится? Включите ?knock_guide_toolbar=true — тулбар отвечает на большинство вопросов.

Какие задачи решает

  • выбрать между feeds и guides под конкретный экран
  • поднять KnockProvider и KnockGuideProvider в React-приложении
  • собрать компонент гида на useGuide с типизированным контентом
  • вытащить slug окружения и channelId через Knock CLI
  • разделить, почему гид не виден: таргетинг или провайдер

Примеры запросов агенту

  • Добавь в приложение Knock-гид: возьми реальный гид из knock guide list и собери под него компонент.
  • Гид не рендерится — пройди чек-лист отладки и включи ?knock_guide_toolbar=true.
  • Мне нужен in-app фид, а не гид: посмотри rules/feeds-vs-guides.md и скажи, что выбрать.

Как установить knock-in-app-ui

1Через Skills CLI (Vercel)

npx skills add knocklabs/skills --skill knock-in-app-ui -a claude-code

2Вручную: положить файлы

~/.claude/skills/knock-in-app-ui/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/knock-in-app-ui/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о knock-in-app-ui

Как установить knock-in-app-ui в Claude Code?

Выполните npx skills add knocklabs/skills --skill knock-in-app-ui -a claude-code. Скилл появится по пути ~/.claude/skills/knock-in-app-ui/SKILL.md.

Что делает knock-in-app-ui?

Разбирает с агентом два продукта Knock для in-app UI и подробно останавливается на гидах: провайдеры, рендер через useGuide и useGuides, отслеживание действий и отладка через тулбар.

Нужна авторизация в Knock CLI?

Да. Агент начинает с knock whoami, при ошибке просит пройти knock login в браузере, а без сессии команды с --environment не отработают.

Исходный текст

SKILL.md · MIT
---
name: knock-in-app-ui
description: Guidance for implementing Knock in-app UI in a web app, with a focus on setting up, rendering, and debugging Knock guides in React.
---

# Knock in-app UI skill

This skill helps you build in-app UI with Knock. It covers the two in-app products — **feeds** and **guides** — at a high level, then goes deep on guides: provider setup, rendering with hooks, and debugging.

Reference: https://docs.knock.app/in-app-ui/overview

## Overview

The skill is organized into four focused rule files. Client-framework guidance is scoped per framework via a `-<framework>` suffix (currently only React). Cross-framework concepts live in unsuffixed files.

1. **Feeds vs. guides** (framework-agnostic) — which product to pick for a given surface and why
2. **Setting up the guide providers in React** — `KnockProvider` and `KnockGuideProvider` props, where each value comes from, and how to sequence them
3. **Rendering guides in React** — building a guide component with `useGuide` / `useGuides`, typed content, and engagement tracking
4. **Debugging guides** (framework-agnostic) — the guides toolbar, the triage checklist, and testing workflow

> **Framework scope:** right now this skill only covers React (`@knocklabs/react`). If the user is building with Vue, Svelte, plain JS, React Native, iOS, or Android, stop and ask how they'd like to proceed — do not adapt the React rules to another client SDK on your own.

## How to use this skill

### When deciding what to build

Start with `rules/feeds-vs-guides.md`:

- Confirm the surface you're building is actually a guide, not a feed
- Check the decision table before picking a direction
- If the answer is "both," wrap the app in `KnockProvider` once and render each product's provider where it's needed

### When adding guides to a React app for the first time

1. Read `rules/setup-guide-providers-react.md`
2. **Before running environment-scoped CLI commands, confirm authentication and inspect the account's environments.** First run `knock whoami` — if it errors with something like "not authenticated" or "no user session," run `knock login` and ask the user to complete the browser flow before continuing. Then run `knock environment list`. If it returns one environment, use that default (production on new accounts); if it returns multiple, ask the user to choose. Remember the slug as `<env-slug>` and pass `--environment <env-slug>` on every subsequent environment-scoped `knock` command.
3. **Before asking the user anything about the channel, discover `channelId` via the Knock CLI:** run `knock channel list --json | jq -r '.[] | select(.key == "knock-guide") | .id'`. Channels are account-scoped, so this command does **not** take `--environment`. If it prints a UUID, use it — do not ask the user to confirm or re-paste. Only ask the user if the CLI returns nothing or errors. See the rule file's "Where to get `channelId`" procedure for the full fallback order.
4. Ask the user only for values that can't be auto-discovered — primarily the public `apiKey` for the chosen environment (and confirm `user.id` is coming from the app's auth context). Do not bundle the `apiKey` ask with `channelId`.
5. Wire `KnockProvider` + `KnockGuideProvider` at the top of the tree.
6. Gate `readyToTarget` on any async data your targeting depends on.
7. **Get a real guide rendering before stopping.** Run `knock guide list --environment <env-slug> --json`, show the user the options (`key`, `name`, each step's `schema_key`), and build the first component against a real guide's actual values. Do not scaffold with placeholder strings like `"changelog-card"`. Fetch the message type schema with `knock message-type get <schema_key> --environment <env-slug> --json` so the content is typed. **If the environment has no guides, offer to scaffold a test one via the Knock CLI** (`knock guide new` → edit the JSON → `knock guide push --environment <env-slug>`) using a built-in message type (`card`, `banner`, or `modal`) with obvious-placeholder content — don't stall waiting for manual dashboard setup. See `rules/rendering-guides-react.md` → "First guide: discover real guides via CLI before writing code" for the full procedure including the empty-environment branch.
8. Flag anything that still needs the user (paste `pk_` key, flip the guide to active in the dashboard, restart dev server) explicitly — don't leave them to discover it by absence.

### When building a new guide component in React

1. Follow the workflow in `rules/rendering-guides-react.md`
2. **Discover the target guide (or message type) via the Knock CLI before picking values.** `knock guide list --environment <env-slug> --json` for the guide's `key` / step `schema_key`; `knock message-type get <schema_key> --environment <env-slug> --json` for the content schema. Avoid placeholder strings.
3. Pick `useGuide` for single-guide surfaces, `useGuides` for lists
4. Define a TypeScript type that mirrors the message type schema you just pulled
5. Wire `markAsSeen`, `markAsInteracted`, and `markAsArchived` — custom components must do this themselves

### When a guide isn't rendering

1. Open `rules/debugging-guides.md` and work the triage checklist top to bottom
2. Turn on the guides toolbar (`?knock_guide_toolbar=true`) first — it answers most questions in seconds
3. Distinguish server-side (targeting/eligibility) from client-side (provider/component) failures before digging deeper

## Rule files reference

- `rules/feeds-vs-guides.md` — product selection between feeds and guides (framework-agnostic)
- `rules/setup-guide-providers-react.md` — configuring `KnockProvider` and `KnockGuideProvider` for guides (React)
- `rules/rendering-guides-react.md` — `useGuide`, `useGuides`, typed content, engagement tracking (React)
- `rules/debugging-guides.md` — toolbar, triage checklist, testing workflow (framework-agnostic)

## Quick reference

The examples below are React. For any other client SDK, see the note at the top of **Overview** before proceeding.

### Providers (minimum viable setup — React)

```tsx
<KnockProvider
  apiKey={process.env.NEXT_PUBLIC_KNOCK_API_KEY}
  user={{ id: currentUser.id }}
>
  <KnockGuideProvider
    channelId={process.env.NEXT_PUBLIC_KNOCK_GUIDE_CHANNEL_ID}
    readyToTarget
    listenForUpdates
  >
    {children}
  </KnockGuideProvider>
</KnockProvider>
```

### Where to source each value

- **Auth first, then environment** — Knock is environment-scoped. Before environment-scoped CLI commands, verify authentication with `knock whoami`; if it errors, run `knock login` and wait for the browser flow. Then run `knock environment list`. When a single environment is returned use it automatically, or ask the user to choose when several exist. Pass `--environment <env-slug>` on every subsequent environment-scoped command; otherwise the CLI uses the account's default environment.
- `apiKey` — Knock dashboard → **Platform → API keys** → public `pk_...` key **from the tab for the chosen environment** (switch envs via the dashboard's environment selector first; remind the user to copy the key for the right env)
- `user.id` — your auth context; must match the id used when identifying the user from your backend
- `channelId` — the **UUID** of the guide channel, not its key. Channels are account-scoped, so `knock channel list` does **not** take `--environment`. **Always attempt CLI discovery before asking the user:**

  ```bash
  knock channel list --json | jq -r '.[] | select(.key == "knock-guide") | .id'
  ```

  If this prints a UUID, use it directly — don't prompt for confirmation. The default guide channel key is `knock-guide` (type `in_app_guide`). Fall back to the dashboard (**Settings → Integrations → Channels**) only if the CLI returns nothing or errors. See `rules/setup-guide-providers-react.md` for the full procedure.

### Hooks at a glance

- `useGuide({ type })` — one guide by message type
- `useGuide({ key })` — one specific guide by key
- `useGuides({ type })` — array of guides by message type
- `useGuideContext()` — low-level client access

### Engagement methods

- `step.markAsSeen()` — impression (call from `useEffect` keyed on `step`)
- `step.markAsInteracted()` — primary action
- `step.markAsArchived()` — dismissal; removes the guide for this user going forward

### First stop when something's wrong

Append `?knock_guide_toolbar=true` to any URL. The toolbar shows all guides, which are active, which this user is eligible for, and why the rest were filtered out.

## Best practices summary

1. **Pick the right product.** Feeds for chronological lists, guides for targeted UI.
2. **Mount providers once, high in the tree.** Inside your auth boundary, above any route that renders guides.
3. **Never pass a placeholder user.** Wait for auth to resolve before mounting `KnockProvider`.
4. **Gate `readyToTarget` on async data** your targeting rules depend on.
5. **Type your content.** `useGuide<T>` should mirror the Knock message type schema.
6. **Always handle engagement.** Custom components must call `markAsSeen`, `markAsInteracted`, and `markAsArchived` themselves.
7. **Use the toolbar first.** Most "the guide isn't showing" questions are answered in seconds.

© knocklabs · MIT · knocklabs/skills

Похожие скиллы

Все скиллы по теме «Фронтенд и UI» →
knock-webhooks hookdeck Скилл knock-webhooks для Claude Code помогает принимать вебхуки Knock и проверять подпись x-knock-signature. Включается при настройке обработчика, отладке проверки или разборе событий уведомлений. CX Codex +1 119установок create-mcp-app modelcontextprotocol Скилл create-mcp-app ведёт агента через сборку MCP App: MCP-инструмент плюс HTML-ресурс с интерфейсом, который хост рисует рядом с результатом инструмента. CX Codex +1 2 800установок nextjs-app-router-fundamentals wsimmonds Скилл nextjs-app-router-fundamentals ведёт агента по Next.js App Router: перенос с Pages Router, вложенные layout, метаданные, динамические маршруты. Пригодится при переходе на app/. CX Codex +1 2 200установок migrate-oai-app modelcontextprotocol Скилл migrate-oai-app переводит интерактивные виджеты с OpenAI Apps SDK на MCP Apps SDK. Помогает заменить синхронный вызов window.openai на событийную модель и настроить домены CSP. CX Codex +1 1 100установок power-apps-code-app-scaffold официальный github Скилл power-apps-code-app-scaffold создаёт каркас Power Apps Code App с React и TypeScript. Подходит для старта проекта с коннектором Power Platform. CX Codex +1 8 700установок nextjs-app-router giuseppe-trisciuoglio Скилл nextjs-app-router для Claude Code помогает создавать приложения на Next.js 16+ с App Router. Подключается при работе с серверными компонентами, формами, API-маршрутами и кэшированием. CX Codex +1 4 100установок

Из того же набора3

Спонсоры проекта

Компании, которые помогают держать аналитику открытой