openclaw-workspace-windows

A TypeScript monorepo template for building, managing, and testing OpenClaw server and CLI tool applications on Windows.

Summary

This workspace provides a well-structured monorepo environment using Yarn v4 and Lerna. It includes ready-to-use OpenClaw server and CLI tools (notably for Feishu message automation), rich resource files, local environment notes, and clear documentation for continuity and operational memory.

Included Assets

• Monorepo Structure:

  • apps/server/ – Koa-based REST API server (TypeScript)
  • apps/tools/ – Feishu CLI/message tools (TypeScript, JS scripts)
  • packages/fake-sample/ – Example TypeScript package

• Workspace Metadata & Scripts:

  • Root package.json – Workspace config & scripts
  • lerna managed publishing and versioning

• Documentation & Memory:

  • AGENTS.md – Workspace self-initialization and session guide
  • SOUL.md – Assistant persona/behavior
  • MEMORY.md, memory/YYYY-MM-DD.md – Operational memory and journal
  • TOOLS.md – Local service, device, and credential notes
  • docs/feishu-message-api.md, docs/push-channels-research.md – API and research

• Testing Assets:

  • assets/test/ – Sample images, videos, etc.
  • apps/tools/assets/test/ – Feishu message JSON/code samples

How to Use

1. Install Dependencies

yarn install

2. Develop and Run Applications

• CLI Tools (Feishu, etc.):

  cd apps/tools
  npm run build        # Compile TypeScript
  # Usage examples in apps/tools/README.md & bin/README.md
  

• Server (REST API):

  cd apps/server
  npm install
  npm run dev          # Start dev server (Koa)
  npm start            # Start in production mode
  # API docs: http://localhost:3000/v1/openapi.json
  

• Scripts:

  • Unified with Yarn workspaces:

    yarn dev:tools
    yarn dev:server
    yarn start:server
    

3. Reference Documentation

• Setup and environment notes: AGENTS.md, SOUL.md, MEMORY.md, TOOLS.md
• Feishu tool: see apps/tools/README.md, apps/tools/bin/README.md, and docs/feishu-message-api.md
• API endpoints and contracts: apps/server/README.md
• Service configs, local device aliases: TOOLS.md
• Sample package usage: packages/fake-sample/README.md

4. Run Tests

• Each package or app provides npm run test (see respective README.md)

5. Add or Update Memory Notes

• Session/context logs: memory/YYYY-MM-DD.md
• Long-term/manual memory: MEMORY.md (private sessions only)

Notes

• Node.js 22+ and Yarn 4+ are required.
• Structure and workspace rules are documented in MEMORY.md and AGENTS.md; monorepo uses Yarn workspaces and Lerna.
• Sensitive data (API keys, tokens) should be managed in TOOLS.md and not committed to version control.
• Use Bash (bash -l) as your default shell for scripts to ensure correct environment variables and aliases.
• Changes to SOUL.md affect assistant behavior—notify the user if altered.
• For Feishu integration/CLI, credentials may be supplied via CLI args, environment variables, or a config file; see tool READMEs for details.
• Test resources may be found in assets/test/ or under tools/test asset folders for Feishu/media sample files.
• Use only as a local/private workspace—no remote ingestion capabilities are present.