# Help

Auto-generated help panel from a keymap



<ComponentPreview base="ink" name="help-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/help
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="ink" name="help" title="components/ui/help.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { Help } from "@/components/ui/help";
```

```tsx
<Help
  title="Keyboard Shortcuts"
  keymap={{
    q: "Quit",
    h: "Help",
    j: "Move down",
    k: "Move up",
  }}
/>
```

API Reference [#api-reference]

Help [#help]

| Prop      | Type                     | Default    |
| --------- | ------------------------ | ---------- |
| `keymap`  | `Record<string, string>` | `required` |
| `title`   | `string`                 | -          |
| `compact` | `boolean`                | `false`    |