Skip to main content

Develop this monorepo

This repository is the CLI, core, and SDK workspace. Use it when you change Shellui itself. App authors should follow Create a project with the published CLI.

To run the full Shellui stack (shell, identity, storage, admin, and siblings), see Local dev stack.

.
├── packages/
│ ├── cli/
│ ├── core/
│ └── sdk/
├── docs/
├── tools/
└── package.json

Agent skills live in the sibling repo shellui/skills (../skills). When you change public CLI, SDK, or config behavior, update the matching skill there and keep it small - see ADR 0001.

Workflow​

This project uses pnpm 9 (packageManager in root package.json).

npm install -g pnpm
pnpm install
pnpm run build

Individual packages:

pnpm run build:cli
pnpm run build:core
pnpm run build:sdk

Tests:

pnpm test

@shellui/cli depends on @shellui/core. @shellui/core depends on @shellui/sdk. Workspace links mean a core change is visible to the CLI without publishing.

Root scripts:

ScriptWhat it does
pnpm start / pnpm run serveRun the shell with the local CLI
pnpm run buildBuild the shell to dist/web/
pnpm run build:packagesBuild every workspace package
pnpm run build:cli / pnpm run build:sdkBuild one package
pnpm run serve:distServe the production build with SPA routing
pnpm testRun the tests of every package
pnpm run format / pnpm run lintFormat with Prettier, lint with ESLint
pnpm run tauri:devRun the desktop wrapper
pnpm run docs:start / pnpm run docs:buildFetch the service docs, then start or build the docs site
pnpm run publishPublish SDK, core and CLI with the dist-tag from the version
pnpm run version:syncCopy the root version to every package
pnpm run cleanRemove every node_modules

The docs site also renders the service docs from identity-service, storage-service, hosting-service, email-service, and ai-service. See Docs site for how they are fetched and how to edit them with live reload.