@jennie-shawn/starwork 0.1.0-alpha.0 → 0.1.0-alpha.1

package/README.md

@@ -1,18 +1,153 @@
-# product
+# StarWork
 
-`product/` 是 StarWork 的正式产品事实源。
+StarWork is an AI workspace protocol and toolkit for keeping long-running work organized across agents, projects, and sessions.
 
-凡是会进入 StarWork 产品、版本、协议、CLI、Pack、适配器、正式文档或发布物的内容，都放在这里。
+It provides:
 
-过程材料、调研笔记、临时草稿先放到 `matters/`，成熟后再晋升到本目录。
+- **Core**: workspace structures, roles, health checks, and project-state conventions.
+- **CLI**: commands for creating, checking, adapting, extending, and spawning workspaces.
+- **Packs**: scenario templates for common workflows.
+- **Skills**: Agent workflows that help Codex and other agents design StarWork workspaces.
 
-## 目录
+StarWork is currently in early A-test. The current package is intended for installation testing, workflow validation, and product feedback.
 
-- `core/`：Core 协议、Kit、Profile、Capability 和 Preset。
-- `cli/`：StarWork CLI 源码、命令规格和命令级文档。
-- `packs/`：正式场景 Pack。
-- `skills/`：StarWork 自研 Agent skill。
-- `adapters/`：不同 Agent 的适配规则和实现。
-- `schemas/`：结构化 schema。
-- `examples/`：正式示例工作区或示例片段。
-- `docs/`：产品文档、路线图、规格说明和对外说明。
+## Install
+
+Install the CLI globally:
+
+```bash
+npm install -g @jennie-shawn/starwork
+starwork --help
+```
+
+Or run it without global installation:
+
+```bash
+npx @jennie-shawn/starwork --help
+```
+
+## Install Skills
+
+StarWork skills are distributed through the `skills` CLI from the GitHub repository.
+
+Install all StarWork skills for Codex:
+
+```bash
+npx skills add jennie-shawn/starwork --skill '*' -g -a codex -y
+```
+
+Install individual skills:
+
+```bash
+npx skills add jennie-shawn/starwork --skill starworkInit -g -a codex -y
+npx skills add jennie-shawn/starwork --skill starworkSpawn -g -a codex -y
+```
+
+Available skills:
+
+- `starworkInit`: helps an agent design a friendly `starwork init` plan for a new workspace.
+- `starworkSpawn`: helps an agent design a `starwork spawn --blueprint` plan for a satellite workspace.
+
+## Quick Start
+
+Create a single-project workspace:
+
+```bash
+starwork init \
+  --type single-matter \
+  --pack general \
+  --name "StarWork A Test" \
+  --target ~/Desktop/starwork-a-test \
+  --yes
+```
+
+Check the workspace:
+
+```bash
+starwork doctor --target ~/Desktop/starwork-a-test
+```
+
+Create a multi-project Hub:
+
+```bash
+starwork init \
+  --type hub \
+  --name "StarWork Hub A Test" \
+  --target ~/Desktop/starwork-hub-a-test \
+  --yes
+```
+
+Spawn a project from the Hub:
+
+```bash
+starwork spawn \
+  --hub ~/Desktop/starwork-hub-a-test \
+  --name "Alpha Project" \
+  --target ~/Desktop/starwork-alpha-project \
+  --mode matter \
+  --yes
+```
+
+Check the spawned project:
+
+```bash
+starwork doctor --target ~/Desktop/starwork-alpha-project
+```
+
+## CLI Commands
+
+```text
+starwork init
+starwork doctor
+starwork spawn
+starwork adapt
+starwork pack install
+```
+
+Current capabilities:
+
+- `init`: creates a local starter workspace, local matter workspace, or multi-project Hub.
+- `doctor`: checks workspace health, required files, Pack installation, and blueprint customization.
+- `spawn`: creates and registers a satellite project from an existing Hub.
+- `adapt`: generates Agent-specific adapter files for Claude Code, Cursor, and related tools.
+- `pack install`: installs supported Packs into compatible workspaces.
+
+## Repository Structure
+
+```text
+.
+├── core/       # StarWork Core protocol, kits, profiles, and presets
+├── cli/        # CLI implementation and command specifications
+├── packs/      # Scenario Packs
+├── skills/     # Agent skills
+├── schemas/    # Structured schemas
+├── adapters/   # Agent adapter rules
+├── examples/   # Examples and sample snippets
+└── docs/       # Product documentation and A-test guides
+```
+
+## A-test Notes
+
+This release is intended for early testers. Please focus feedback on:
+
+- whether the CLI installs and runs cleanly;
+- whether generated workspace structures are easy to understand;
+- whether `doctor` explains problems clearly;
+- whether Hub + Satellite workflows feel natural;
+- whether `starworkInit` and `starworkSpawn` can be discovered and used by Codex.
+
+For a fuller test script, see [docs/alpha-test-guide.md](docs/alpha-test-guide.md).
+
+## Development
+
+Run the test suite:
+
+```bash
+npm test
+```
+
+Preview the npm package contents:
+
+```bash
+npm pack --dry-run
+```

package/docs/alpha-test-guide.md

@@ -6,21 +6,21 @@
 - GitHub repository：`jennie-shawn/starwork`
 - npm package：`@jennie-shawn/starwork`
 - CLI command：`starwork`
-- A 测 tag：`alpha`
+- A 测 tag：`latest`
 
 ## A 测用户安装 CLI
 
 全局安装：
 
 ```bash
-npm install -g @jennie-shawn/starwork@alpha
+npm install -g @jennie-shawn/starwork
 starwork --help
 ```
 
 不全局安装：
 
 ```bash
-npx @jennie-shawn/starwork@alpha --help
+npx @jennie-shawn/starwork --help
 ```
 
 ## A 测用户安装 Skills

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jennie-shawn/starwork",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0-alpha.1",
   "description": "StarWork Core, CLI, Packs, and Agent skills for AI workspaces.",
   "type": "commonjs",
   "bin": {
@@ -23,7 +23,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "alpha"
+    "tag": "latest"
   },
   "scripts": {
     "starwork": "node cli/bin/starwork.js",