Skip to content
Client OS
Menu

Get started

Get started

Five commands take you from clone to a running stack. You need access to the catesworks organization on GitHub: the source repository is private.

Read the docsAsk about access

From clone to a running stack

  1. Step 1

    Clone

    `git clone https://github.com/catesworks/client-os.git`, then `cd client-os`. To start without its git history, use `npx degit catesworks/client-os my-app` instead.

  2. Step 2

    Install

    `pnpm install` installs every app and package in the workspace.

  3. Step 3

    Start Supabase

    `pnpm supabase:start` runs the local Supabase stack (Postgres, Auth, Storage) in Docker.

  4. Step 4

    Run the stack

    `pnpm dev` migrates and seeds the database, creates the demo accounts, then starts the web app on http://localhost:3026 and the API on http://localhost:4026.

What you need

  • Read access to the catesworks/client-os repository
  • Node.js 22 or later and pnpm
  • Docker, for the local Supabase stack
  • process-compose, which `pnpm dev` runs

The commands

git clone https://github.com/catesworks/client-os.git
cd client-os
pnpm install
pnpm supabase:start
pnpm dev

The `client` CLI and the desktop app are built from source inside the workspace. Their release pipeline exists, but no release so far has published binaries, and the CLI is not on npm.

Only want the clientos-context skill?

The clientos-context skill is the one part published on its own. It is on npm as @client-os/skill-clientos-context, and works without the rest of the monorepo.

npm install @client-os/skill-clientos-context

The package on npm →