Quick Start

Get started in
three steps.

Install, configure, build.

Install the package.

One command. That's it.

Also available via yarn add and pnpm add

Configure the provider.

Wrap your app with CmdopProvider.

app/providers.tsx

Tsx

import { CmdopProvider } from '@cmdop/react';

export function App({ children }) {
  return (
    <CmdopProvider
      wsUrl="wss://ws.cmdop.com/connection/websocket"
      getToken={() => getAuthToken()}
    >
      {children}
    </CmdopProvider>
  );
}

Loading code...

Start building.

Use the hooks in your components.

components/Terminal.tsx

Tsx

import { useTerminal } from '@cmdop/react';

function Terminal() {
  const { execute, output } = useTerminal();

  return (
    <div>
      <button onClick={() => execute('ls -la')}>
        Run Command
      </button>
      <pre>{output}</pre>
    </div>
  );
}

Loading code...

Ready to explore?

Try the interactive playground or dive into the documentation.

Open Playground Documentation

Get started inthree steps.

Install the package.

Configure the provider.

Start building.

Ready to explore?

Get started in
three steps.