AgentSkillsCN

using-workspaces

工作区插件的概览与入门指南。当用户询问“如何使用工作区”“工作区帮助”或“工作区入门”时,可使用此技能。

SKILL.md
--- frontmatter
name: using-workspaces
description: Overview and getting started guide for the workspaces plugin. Use when user asks "how do I use workspaces", "workspaces help", or "getting started with workspaces".

Skill: Using Workspaces

Description

This skill provides an overview of the workspaces plugin and how to use it effectively for managing multi-project/multi-repo workflows.

Instructions

When the user asks about using the workspaces plugin, provide this overview:

Workspaces Overview

The workspaces plugin helps you manage multiple related repositories that belong to the same company or project. Perfect for teams working with microservices, polyrepos, or any multi-project setup.

Quick Start

  1. Initialize a workspace: /workspaces:init

    • Creates a new workspace configuration
    • Add your projects with their repos, paths, and ports
  2. Clone repositories: /workspaces:clone all

    • Clone all configured repos to their designated paths
  3. Set up projects: /workspaces:setup all

    • Run setup scripts (install deps, migrations, etc.)
  4. Verify everything: /workspaces:doctor

    • Check prerequisites and run health checks
  5. Check status: /workspaces:status

    • See git status, branches, and running services across all projects

Configuration

Workspace configs are stored in ~/.claude/workspaces/<workspace-name>/:

  • WORKSPACE.md - Main configuration with projects, relationships, and commands

Available Commands

CommandDescription
/workspaces:initCreate a new workspace
/workspaces:statusShow status across all projects
/workspaces:cloneClone repositories
/workspaces:setupRun setup scripts
/workspaces:startStart services
/workspaces:stopStop services
/workspaces:affectedShow dependency graph
/workspaces:searchSearch across all projects
/workspaces:doctorCheck prerequisites and health

Tips

  • Use /workspaces:affected api to see what depends on the API before making breaking changes
  • Use /workspaces:search "TODO" to find TODOs across all projects
  • Run /workspaces:doctor when something isn't working