Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

9.3 KB
Raw Blame
import { useActions, useValues } from 'kea'
import { useEffect, useRef, useState } from 'react'

import { IconCopy, IconInfo, IconStopFilled, IconX } from '@posthog/icons'
import { LemonBanner, LemonButton, LemonMenu, LemonSelect, LemonTag, Popover } from '@posthog/lemon-ui'

import { IconClipboardEdit } from 'lib/lemon-ui/icons'

import { terminalLogic } from './terminalLogic'

const examples = [
    {
        title: 'Get started',
        commands: ['ls --color=auto', "find /posthog/files -name '*.md'", 'cat /posthog/README.txt', 'ph help'],
    },
    {
        title: 'Explore files',
        commands: [
            'mc',
            'tree -C -L 3 /posthog/files',
            'ncdu -r /posthog/files',
            'ls -lh /posthog/api',
            'pwd',
            'busybox',
        ],
    },
    { title: 'Optional tools', commands: ['node --version', 'pi --help', 'nyancat', 'doom'] },
    { title: 'PostHog tools', commands: ['ph tools', 'ph tools notebook', 'ph help notebooks-retrieve', 'ph refresh'] },
    {
        title: 'Edit and organize',
        commands: [
            'nano Unfiled/Notebooks/Foobar.md',
            "find /posthog/files -name '*.json'",
            'vi Unfiled/Notebooks/Foobar.md',
            'mkdir -p Research/Archive',
            'mv Unfiled/Notebooks/Foobar.md Research/Archive/',
        ],
    },
    {
        title: 'Read and filter',
        commands: [
            'ph notebooks-list --limit 10 | jq .',
            "grep -r -n 'revenue' /posthog/files",
            "find /posthog/files -name '*.md' | wc -l",
            'jq -n \'{hello: "PostHog"}\'',
            'less /posthog/README.txt',
            'ls -la /tmp',
        ],
    },
]

export function TerminalView({
    active: visible = true,
    onClose,
}: {
    active?: boolean
    onClose?: () => void
}): JSX.Element {
    const { status, error, saveError, hasSelection, pasting, clipboardError } = useValues(terminalLogic)
    const { start, stop, attach, detach, insertCommand, copy, paste } = useActions(terminalLogic)
    const container = useRef<HTMLDivElement>(null)
    const [infoOpen, setInfoOpen] = useState(false)
    useEffect(() => {
        const host = container.current
        if (!host || !visible) {
            return
        }
        attach(host)
        return () => detach(host)
    }, [attach, detach, visible])

    const active = status !== 'idle' && status !== 'error'
    const starting = status === 'loading' || status === 'booting'

    return (
        <div className="h-full min-h-0 flex flex-col gap-1">
            <div className="flex shrink-0 items-center gap-1 flex-wrap px-1">
                <LemonSelect
                    size="xsmall"
                    value="posthog-linux-wasm"
                    aria-label="Environment"
                    data-attr="terminal-environment"
                    className="min-w-0 max-w-full"
                    truncateText={{ maxWidthClass: 'max-w-full' }}
                    options={[
                        {
                            title: 'Environment',
                            options: [
                                {
                                    value: 'posthog-linux-wasm',
                                    label: 'PostHog Linux WASM (in-browser, experimental)',
                                },
                            ],
                        },
                    ]}
                />
                <LemonButton
                    size="xsmall"
                    type="primary"
                    onClick={start}
                    loading={starting}
                    disabledReason={active ? 'The terminal is already running' : undefined}
                    data-attr="terminal-start"
                >
                    Start Linux
                </LemonButton>
                <LemonButton
                    size="xsmall"
                    icon={<IconStopFilled />}
                    aria-label="Stop"
                    tooltip="Stop"
                    onClick={stop}
                    disabledReason={status === 'idle' ? 'Start the terminal first' : undefined}
                    data-attr="terminal-stop"
                />
                <LemonButton
                    size="xsmall"
                    icon={<IconCopy />}
                    aria-label="Copy"
                    tooltip="Copy"
                    onClick={copy}
                    disabledReason={!hasSelection ? 'Select terminal text to copy' : undefined}
                    data-attr="terminal-copy"
                />
                <LemonButton
                    size="xsmall"
                    icon={<IconClipboardEdit />}
                    aria-label="Paste"
                    tooltip="Paste"
                    onClick={paste}
                    loading={pasting}
                    disabledReason={status !== 'ready' ? 'Start the terminal first' : undefined}
                    data-attr="terminal-paste"
                />
                <LemonMenu
                    items={examples.map(({ title, commands }) => ({
                        title,
                        items: commands.map((command) => ({
                            label: <code className="whitespace-normal break-words">{command}</code>,
                            onClick: () => insertCommand(command),
                        })),
                    }))}
                >
                    <LemonButton
                        size="xsmall"
                        type="secondary"
                        aria-label="Examples"
                        tooltip="Insert a command, then press Enter to run it."
                        disabledReason={status !== 'ready' ? 'Start the terminal first' : undefined}
                    >
                        Examples
                    </LemonButton>
                </LemonMenu>
                <span role="status" className="text-secondary ml-auto text-xs">
                    {status === 'loading'
                        ? 'Starting terminal…'
                        : status === 'booting'
                          ? 'Starting Linux…'
                          : status === 'ready'
                            ? 'Ready'
                            : status === 'error'
                              ? 'Could not start'
                              : 'Stopped'}
                </span>
                <Popover
                    visible={infoOpen}
                    onClickOutside={() => setInfoOpen(false)}
                    placement="bottom-end"
                    overlay={
                        <div className="flex max-w-80 flex-col items-start gap-3 p-1 text-sm">
                            <LemonTag type="warning">Experiment</LemonTag>
                            <p className="mb-0">
                                Linux in your browser, with your PostHog project mounted at <code>/posthog</code>. The
                                first start downloads Linux and bundled tools.
                            </p>
                            <p className="mb-0">
                                Commands and file edits can change real data. Local files and unsaved edits disappear
                                when you reload PostHog or stop Linux.
                            </p>
                            <p className="mb-0">
                                Choose an example to insert it, then press Enter. Tab completes paths and ph commands.
                                Ctrl+C interrupts. Scroll up for history.
                            </p>
                            <p className="mb-0">
                                Selecting text copies it automatically. In apps that capture the mouse, such as mc, hold
                                Option on macOS or Shift on Linux and Windows while selecting. Copy/paste with ⌘C/⌘V on
                                macOS or Ctrl+Shift+C/V on Linux and Windows.
                            </p>
                        </div>
                    }
                >
                    <LemonButton
                        size="xsmall"
                        icon={<IconInfo />}
                        aria-label="Terminal information"
                        aria-expanded={infoOpen}
                        active={infoOpen}
                        onClick={() => setInfoOpen(!infoOpen)}
                    />
                </Popover>
                {onClose && (
                    <LemonButton
                        size="xsmall"
                        icon={<IconX />}
                        aria-label="Hide terminal"
                        tooltip="Hide terminal"
                        onClick={onClose}
                    />
                )}
            </div>
            {error && <LemonBanner type="error">{error}</LemonBanner>}
            {saveError && <LemonBanner type="error">{saveError}</LemonBanner>}
            {clipboardError && <LemonBanner type="error">{clipboardError}</LemonBanner>}
            <div
                aria-label="Linux terminal"
                data-attr="posthog-terminal"
                translate="no"
                className="min-h-0 min-w-0 flex-1 overflow-hidden px-1 pb-1 bg-[var(--color-black)] text-[var(--color-white)]"
            >
                {/* xterm's fit addon counts padding on its parent as usable space. */}
                <div ref={container} className="h-full min-w-0 bg-[var(--color-black)]" />
            </div>
        </div>
    )
}