# Embedded Terminal

Embedded PTY terminal panel (requires node-pty peer)



<ComponentPreview base="ink" name="embedded-terminal-demo" />

<Callout type="info">
  Embedded terminal requires Node.js and may not render in the browser preview.
</Callout>

Installation [#installation]

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

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

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

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

      <ComponentSource base="ink" name="embedded-terminal" title="components/ui/embedded-terminal.tsx" />

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

Usage [#usage]

```tsx
import { EmbeddedTerminal } from "@/components/ui/embedded-terminal";
```

```tsx
<EmbeddedTerminal
  command="bash"
  args={["-c", "echo Hello world"]}
  width={80}
  height={24}
  onExit={(code) => console.log(`Exited with ${code}`)}
/>
```

API Reference [#api-reference]

EmbeddedTerminal [#embeddedterminal]

| Prop      | Type                     | Default    |
| --------- | ------------------------ | ---------- |
| `command` | `string`                 | `required` |
| `args`    | `string[]`               | `[]`       |
| `cwd`     | `string`                 | -          |
| `width`   | `number`                 | `80`       |
| `height`  | `number`                 | `24`       |
| `onExit`  | `(code: number) => void` | -          |