campfire-cli 0.1.0__py3-none-any.whl

campfire_cli/app/workspace/SPEC.md

@@ -0,0 +1,25 @@
+# Workspace App SPEC
+
+本模块管理 Workspace、Space、Domain、Project 注册表和 Workspace 初始化。Workspace id 与 Project id 是本机治理状态的稳定键；路径只是可变定位信息。用户级 `CAMPFIRE_HOME/campfire.db` 是唯一数据库，保存注册数据、文档索引和工作流状态；每个 Workspace 只保留配置与人类可审阅的运行产物，不再拥有独立数据库。所有工具状态均位于 `CAMPFIRE_HOME`，不得向目标 Workspace 创建工具状态目录。
+
+解析优先级为显式 `--workspace`、当前目录所属的已注册 Workspace、默认 Workspace。写操作仍由具体业务模块执行。
+
+`workspace add` 只接入已存在目录；`workspace create` 要求目标路径不存在，并创建全局收件箱、带 `_空间.md` 的知识/工作 Space 和治理视图基础目录。两者写入全局 SQLite 注册表，不向 Workspace 写工具状态。
+
+`workspace space/domain create` 只创建不存在的新目录；对应的 `adopt` 原地纳管已有目录，只新增 `_空间.md`，或 `_领域.md` 和声明的 MOC，不移动、改名或删除已有内容。两者默认只输出计划，追加 `--confirm` 才写入。
+
+`workspace config check` 统一校验包内产品默认值和当前 Workspace 的有效治理契约，包括目录与 Space 冲突、文档类型前缀、Profile 引用和继承、归档策略以及托管资源列表。
+
+`workspace restructure` 负责一次性改变已有 Workspace 的物理结构：冻结范围、生成带内容哈希的审批计划、执行跨领域移动或改名、更新引用并验证迁移事实。纯移动不得重写文档内容；`verify` 只验证本批次 source/target 结果，文档格式合规由 Maintenance 独立检查。该能力属于 Workspace Service，不设独立 App，也不用于日常增量维护。
+
+Space 是 Workspace 根下以 `_空间.md` 声明的顶级内容容器；Domain 位于 Space 内，以 `_领域.md` 声明并可任意嵌套。子 Domain 必须处于父 Domain 路径下、属于同一 Space 并继承 governance。`_收件箱` 与 `治理视图` 是系统区域，不是 Space。Maintenance 只消费本模块发现的结构，不维护第二套领域规则。
+
+Space 与 Domain 声明文件只由本模块解释和校验；Document App 对其返回 `not-applicable`。`workspace space check --space <id>` 支持对单个 Space 做局部复检。
+
+Project 是 Workspace 连接的外部工作资源，记录稳定 id、显示名称、文档领域、本地代码路径、Git remote、默认分支和生命周期状态。Project 业务代码归属本模块，对外使用 `campfire workspace project` 子命令。提供本地 Git 路径时可自动发现 remote 和分支；动态 Git 状态不写入注册表。
+
+`project resolve` 只按规范化后的本地 Git 根目录和 remote 识别已注册 Project，不凭目录名称猜测；零匹配和多匹配都返回可判断状态。`project check` 只报告源码路径、remote、默认分支和文档领域的漂移，不自动更新稳定身份或归属。
+
+`project create` 用于新 Project onboarding，默认只返回计划，追加 `--confirm` 后通过 Domain Service 创建工作 Space 内的项目根 Domain 并注册 Project。初始化不虚构业务子领域；已存在文档中心必须使用 `project add` 接入。
+
+注册数据只通过 CLI 和 SQLite 维护。JSON 仅用于显式 export/import；import 默认只预检，必须使用 `--confirm` 才替换当前注册数据。不读取旧 JSON 注册表，不维护双事实源。

campfire_cli/app/workspace/__init__.py

@@ -0,0 +1 @@
+"""Registered Workspace management application."""

campfire_cli/app/workspace/cli/__init__.py

@@ -0,0 +1 @@
+"""Workspace CLI delivery adapter."""

campfire_cli/app/workspace/cli/adoption_cli.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+import typer
+
+from campfire_cli.common.exceptions import AppError
+from campfire_cli.container import AppContainer
+
+adoption_cli = typer.Typer(
+    help="把已有文档文件夹安全接管为受管 Domain",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+def service(ctx: typer.Context):
+    return AppContainer.build(ctx.find_root().params.get("workspace")).adoption
+
+
+def invoke(operation) -> None:
+    try:
+        result = operation()
+        typer.echo(json.dumps(result.model_dump(mode="json"), ensure_ascii=False, indent=2))
+    except AppError as exc:
+        typer.echo(json.dumps({"status": "error", "message": str(exc)}, ensure_ascii=False))
+        raise typer.Exit(exc.exit_code) from exc
+
+
+@adoption_cli.command("inventory")
+def inventory(
+    ctx: typer.Context,
+    source: Path = typer.Option(..., "--source"),
+    batch: str = typer.Option(..., "--batch"),
+    confirm: bool = typer.Option(False, "--confirm"),
+) -> None:
+    """盘点目录；外部来源追加 --confirm 后复制到待接管暂存区。"""
+    invoke(lambda: service(ctx).inventory(batch, source, confirm))
+
+
+@adoption_cli.command("plan")
+def plan(
+    ctx: typer.Context,
+    batch: str = typer.Option(..., "--batch"),
+    target_path: str = typer.Option(..., "--target-path"),
+    domain_id: str = typer.Option(..., "--domain-id"),
+    name: str = typer.Option(..., "--name"),
+    space_id: str = typer.Option(..., "--space"),
+    domain_type: str = typer.Option(..., "--type"),
+    governance: str = typer.Option(..., "--governance"),
+    parent_domain: str | None = typer.Option(None, "--parent-domain"),
+    project_id: str | None = typer.Option(None, "--project"),
+) -> None:
+    """声明整个来源文件夹的目标 Domain，并生成接管计划。"""
+    invoke(
+        lambda: service(ctx).plan(
+            batch,
+            target_path=target_path,
+            domain_id=domain_id,
+            name=name,
+            space_id=space_id,
+            domain_type=domain_type,
+            governance=governance,
+            parent_domain=parent_domain,
+            project_id=project_id,
+        )
+    )
+
+
+@adoption_cli.command("apply")
+def apply(
+    ctx: typer.Context,
+    batch: str = typer.Option(..., "--batch"),
+    confirm: bool = typer.Option(False, "--confirm"),
+) -> None:
+    """预检接管计划；追加 --confirm 后移动到正式领域并建立声明。"""
+    invoke(lambda: service(ctx).apply(batch, confirm))
+
+
+@adoption_cli.command("verify")
+def verify(ctx: typer.Context, batch: str = typer.Option(..., "--batch")) -> None:
+    """验证文件哈希、领域声明与最终位置。"""
+    invoke(lambda: service(ctx).verify(batch))

campfire_cli/app/workspace/cli/config_cli.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+
+from campfire_cli.app.workspace.cli.workspace_cli import emit, invoke
+from campfire_cli.app.workspace.repository.workspace_repository import SqliteWorkspaceRepository
+from campfire_cli.app.workspace.service.config_service import WorkspaceConfigService
+from campfire_cli.app.workspace.service.workspace_service import WorkspaceService
+from campfire_cli.config.settings import WorkspaceSettings, campfire_home
+
+config_cli = typer.Typer(
+    help="检查 Workspace 治理配置契约",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+def service(workspace: str | None) -> WorkspaceConfigService:
+    home = campfire_home()
+    resolved = WorkspaceService(home, SqliteWorkspaceRepository(home)).resolve(
+        workspace, Path.cwd()
+    )
+    settings = WorkspaceSettings.load(resolved.workspace_id, Path(resolved.workspace))
+    return WorkspaceConfigService(settings)
+
+
+@config_cli.command("check")
+def check(workspace: str | None = typer.Option(None, "--workspace")) -> None:
+    emit(invoke(lambda: service(workspace).check()))

campfire_cli/app/workspace/cli/domain_cli.py

@@ -0,0 +1,101 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+
+from campfire_cli.app.workspace.cli.workspace_cli import emit, invoke
+from campfire_cli.app.workspace.repository.workspace_repository import SqliteWorkspaceRepository
+from campfire_cli.app.workspace.service.structure_service import DomainService
+from campfire_cli.app.workspace.service.workspace_service import WorkspaceService
+from campfire_cli.config.settings import campfire_home
+
+domain_cli = typer.Typer(
+    help="管理 Space 内可嵌套的内容领域", context_settings={"help_option_names": ["-h", "--help"]}
+)
+
+
+def service(workspace: str | None) -> DomainService:
+    home = campfire_home()
+    resolved = WorkspaceService(home, SqliteWorkspaceRepository(home)).resolve(
+        workspace, Path.cwd()
+    )
+    return DomainService(Path(resolved.workspace), home)
+
+
+@domain_cli.command("list")
+def list_domains(
+    space: str | None = typer.Option(None, "--space"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    emit(invoke(lambda: service(workspace).list(space)))
+
+
+@domain_cli.command("show")
+def show(domain_id: str, workspace: str | None = typer.Option(None, "--workspace")) -> None:
+    emit(invoke(lambda: service(workspace).show(domain_id)))
+
+
+@domain_cli.command("check")
+def check(workspace: str | None = typer.Option(None, "--workspace")) -> None:
+    emit(invoke(lambda: service(workspace).check()))
+
+
+@domain_cli.command("create")
+def create(
+    domain_id: str = typer.Option(..., "--id"),
+    name: str = typer.Option(..., "--name"),
+    path: str = typer.Option(..., "--path"),
+    space: str = typer.Option(..., "--space"),
+    domain_type: str = typer.Option(..., "--type"),
+    governance: str = typer.Option(..., "--governance"),
+    parent: str | None = typer.Option(None, "--parent"),
+    project: str | None = typer.Option(None, "--project"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+    confirm: bool = typer.Option(False, "--confirm"),
+) -> None:
+    emit(
+        invoke(
+            lambda: service(workspace).create(
+                domain_id=domain_id,
+                name=name,
+                path=path,
+                space_id=space,
+                domain_type=domain_type,
+                governance=governance,
+                parent_domain=parent,
+                project_id=project,
+                confirm=confirm,
+            )
+        )
+    )
+
+
+@domain_cli.command("adopt")
+def adopt(
+    domain_id: str = typer.Option(..., "--id"),
+    name: str = typer.Option(..., "--name"),
+    path: str = typer.Option(..., "--path"),
+    space: str = typer.Option(..., "--space"),
+    domain_type: str = typer.Option(..., "--type"),
+    governance: str = typer.Option(..., "--governance"),
+    parent: str | None = typer.Option(None, "--parent"),
+    project: str | None = typer.Option(None, "--project"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+    confirm: bool = typer.Option(False, "--confirm"),
+) -> None:
+    emit(
+        invoke(
+            lambda: service(workspace).adopt(
+                domain_id=domain_id,
+                name=name,
+                path=path,
+                space_id=space,
+                domain_type=domain_type,
+                governance=governance,
+                parent_domain=parent,
+                project_id=project,
+                confirm=confirm,
+            )
+        )
+    )

campfire_cli/app/workspace/cli/project_cli.py

@@ -0,0 +1,135 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+
+from campfire_cli.app.workspace.cli.workspace_cli import emit, invoke
+from campfire_cli.app.workspace.repository.workspace_repository import SqliteWorkspaceRepository
+from campfire_cli.app.workspace.schema.workspace_schema import ProjectUpsertRequest
+from campfire_cli.app.workspace.service.project_service import ProjectService
+from campfire_cli.config.settings import campfire_home
+
+project_cli = typer.Typer(
+    help="注册代码项目及其 Workspace 文档领域",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+def service() -> ProjectService:
+    root = campfire_home()
+    return ProjectService(root, SqliteWorkspaceRepository(root))
+
+
+def request(
+    project_id: str,
+    workspace_id: str,
+    name: str,
+    document_domain: str,
+    local_path: Path | None,
+    git_remote_url: str | None,
+    default_branch: str | None,
+    status: str,
+) -> ProjectUpsertRequest:
+    return ProjectUpsertRequest(
+        project_id=project_id,
+        workspace_id=workspace_id,
+        name=name,
+        document_domain=document_domain,
+        local_path=local_path,
+        git_remote_url=git_remote_url,
+        default_branch=default_branch,
+        status=status,
+    )
+
+
+def project_options(operation: str):
+    def command(
+        project_id: str = typer.Option(..., "--id"),
+        workspace_id: str = typer.Option(..., "--workspace"),
+        name: str = typer.Option(..., "--name"),
+        document_domain: str = typer.Option(..., "--document-domain"),
+        local_path: Path | None = typer.Option(None, "--local-path"),
+        git_remote_url: str | None = typer.Option(None, "--git-remote-url"),
+        default_branch: str | None = typer.Option(None, "--default-branch"),
+        status: str = typer.Option("active", "--status"),
+    ) -> None:
+        payload = request(
+            project_id,
+            workspace_id,
+            name,
+            document_domain,
+            local_path,
+            git_remote_url,
+            default_branch,
+            status,
+        )
+        target = service()
+        emit(invoke(lambda: getattr(target, operation)(payload)))
+
+    return command
+
+
+project_cli.command("add", help="注册一个新 Project；提供本地 Git 路径时自动发现 remote 和分支。")(
+    project_options("add")
+)
+project_cli.command("update", help="完整更新一个已注册 Project。")(project_options("update"))
+
+
+@project_cli.command("create")
+def create(
+    project_id: str = typer.Option(..., "--id"),
+    workspace_id: str = typer.Option(..., "--workspace"),
+    name: str = typer.Option(..., "--name"),
+    document_domain: str = typer.Option(..., "--document-domain"),
+    local_path: Path | None = typer.Option(None, "--local-path"),
+    git_remote_url: str | None = typer.Option(None, "--git-remote-url"),
+    default_branch: str | None = typer.Option(None, "--default-branch"),
+    status: str = typer.Option("active", "--status"),
+    confirm: bool = typer.Option(False, "--confirm"),
+) -> None:
+    """预览并初始化新 Project 文档中心；追加 --confirm 后创建并注册。"""
+    payload = request(
+        project_id,
+        workspace_id,
+        name,
+        document_domain,
+        local_path,
+        git_remote_url,
+        default_branch,
+        status,
+    )
+    emit(invoke(lambda: service().create(payload, confirm)))
+
+
+@project_cli.command("list")
+def list_projects(workspace_id: str | None = typer.Option(None, "--workspace")) -> None:
+    """列出全部 Project，或按 Workspace 过滤。"""
+    emit(invoke(lambda: service().list(workspace_id)))
+
+
+@project_cli.command("show")
+def show(project_id: str) -> None:
+    """显示一个 Project 的注册元数据。"""
+    emit(invoke(lambda: service().show(project_id)))
+
+
+@project_cli.command("resolve")
+def resolve(path: Path | None = typer.Option(None, "--path")) -> None:
+    """按本地路径和 Git remote 解析已注册 Project，不修改注册数据。"""
+    emit(invoke(lambda: service().resolve(path or Path.cwd())))
+
+
+@project_cli.command("check")
+def check(project_id: str) -> None:
+    """检查 Project 的源码路径、Git 信息和文档领域是否仍然有效。"""
+    emit(invoke(lambda: service().check(project_id)))
+
+
+@project_cli.command("bind")
+def bind(
+    project_id: str = typer.Option(..., "--id"),
+    local_path: Path = typer.Option(..., "--local-path"),
+) -> None:
+    """在当前设备上绑定 Project 源码路径，不把绝对路径写入 Manifest。"""
+    emit(invoke(lambda: service().bind(project_id, local_path)))

campfire_cli/app/workspace/cli/restructure_cli.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+import typer
+
+from campfire_cli.common.governance import enrich_issue
+from campfire_cli.container import AppContainer
+
+restructure_cli = typer.Typer(
+    help="按审批计划重构 Workspace 物理结构",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+domain_restructure_cli = typer.Typer(
+    help="重构领域名称、路径或稳定身份",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+restructure_cli.add_typer(domain_restructure_cli, name="domain")
+
+
+def emit(result: object) -> None:
+    payload = result.model_dump(mode="json")
+    payload["issues"] = [enrich_issue(issue) for issue in payload.get("issues", [])]
+    typer.echo(json.dumps(payload, ensure_ascii=False, indent=2))
+
+
+def service(ctx: typer.Context, workspace: str | None):
+    selector = workspace or ctx.find_root().params.get("workspace")
+    return AppContainer.build(selector).restructure
+
+
+def domain_service(ctx: typer.Context, workspace: str | None):
+    selector = workspace or ctx.find_root().params.get("workspace")
+    return AppContainer.build(selector).domain_restructure
+
+
+@domain_restructure_cli.command("rename")
+def rename_domain(
+    ctx: typer.Context,
+    domain_id: str = typer.Option(..., "--domain"),
+    name: str = typer.Option(..., "--name"),
+    rename_directory: bool = typer.Option(False, "--rename-directory"),
+    target_path: str | None = typer.Option(None, "--target-path"),
+    project_name: str | None = typer.Option(None, "--project-name"),
+    confirm: bool = typer.Option(False, "--confirm"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    """修改领域显示名称；可显式联动目录和 Project 展示名称。"""
+    emit(
+        domain_service(ctx, workspace).rename(
+            domain_id,
+            name,
+            rename_directory=rename_directory,
+            target_path=target_path,
+            project_name=project_name,
+            confirm=confirm,
+        )
+    )
+
+
+@domain_restructure_cli.command("move")
+def move_domain(
+    ctx: typer.Context,
+    domain_id: str = typer.Option(..., "--domain"),
+    target_path: str = typer.Option(..., "--target-path"),
+    parent_domain: str | None = typer.Option(None, "--parent-domain"),
+    confirm: bool = typer.Option(False, "--confirm"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    """移动完整领域目录，并更新父领域、Project、Manifest 和路径引用。"""
+    emit(
+        domain_service(ctx, workspace).move(
+            domain_id, target_path, parent_domain=parent_domain, confirm=confirm
+        )
+    )
+
+
+@domain_restructure_cli.command("rekey")
+def rekey_domain(
+    ctx: typer.Context,
+    domain_id: str = typer.Option(..., "--domain"),
+    new_id: str = typer.Option(..., "--new-id"),
+    confirm: bool = typer.Option(False, "--confirm"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    """高风险修改稳定 domain_id，并更新直接子领域引用。"""
+    emit(domain_service(ctx, workspace).rekey(domain_id, new_id, confirm=confirm))
+
+
+@restructure_cli.command("inventory")
+def inventory(
+    ctx: typer.Context,
+    scope: str = typer.Option(..., "--scope"),
+    batch: str = typer.Option(..., "--batch"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    """冻结范围并生成批次事实清单。"""
+    emit(service(ctx, workspace).inventory(batch, scope))
+
+
+@restructure_cli.command("plan")
+def plan(
+    ctx: typer.Context,
+    batch: str = typer.Option(..., "--batch"),
+    spec: Path | None = typer.Option(
+        None, "--spec", help="显式重构意图 YAML/JSON；支持跨目录移动和 Frontmatter Patch"
+    ),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    """生成带源哈希且默认未审批的逐文件计划。"""
+    emit(service(ctx, workspace).plan(batch, spec))
+
+
+@restructure_cli.command("apply")
+def apply(
+    ctx: typer.Context,
+    batch: str = typer.Option(..., "--batch"),
+    confirm: bool = typer.Option(False, "--confirm"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    """预检或执行已审批批次。"""
+    emit(service(ctx, workspace).apply(batch, confirm))
+
+
+@restructure_cli.command("verify")
+def verify(
+    ctx: typer.Context,
+    batch: str = typer.Option(..., "--batch"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    """执行批次最终验收并固化结果。"""
+    emit(service(ctx, workspace).verify(batch))

campfire_cli/app/workspace/cli/space_cli.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+
+from campfire_cli.app.workspace.cli.workspace_cli import emit, invoke
+from campfire_cli.app.workspace.repository.workspace_repository import SqliteWorkspaceRepository
+from campfire_cli.app.workspace.service.structure_service import SpaceService
+from campfire_cli.app.workspace.service.workspace_service import WorkspaceService
+from campfire_cli.config.settings import campfire_home
+
+space_cli = typer.Typer(
+    help="管理 Workspace 顶级内容空间", context_settings={"help_option_names": ["-h", "--help"]}
+)
+
+
+def service(workspace: str | None) -> SpaceService:
+    home = campfire_home()
+    resolved = WorkspaceService(home, SqliteWorkspaceRepository(home)).resolve(
+        workspace, Path.cwd()
+    )
+    return SpaceService(Path(resolved.workspace), home)
+
+
+@space_cli.command("list")
+def list_spaces(workspace: str | None = typer.Option(None, "--workspace")) -> None:
+    emit(invoke(lambda: service(workspace).list()))
+
+
+@space_cli.command("show")
+def show(space_id: str, workspace: str | None = typer.Option(None, "--workspace")) -> None:
+    emit(invoke(lambda: service(workspace).show(space_id)))
+
+
+@space_cli.command("check")
+def check(
+    space_id: str | None = typer.Option(None, "--space", help="只检查指定 Space id"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+) -> None:
+    emit(invoke(lambda: service(workspace).check(space_id)))
+
+
+@space_cli.command("create")
+def create(
+    space_id: str = typer.Option(..., "--id"),
+    name: str = typer.Option(..., "--name"),
+    path: str = typer.Option(..., "--path"),
+    space_type: str = typer.Option(..., "--type"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+    confirm: bool = typer.Option(False, "--confirm"),
+) -> None:
+    emit(invoke(lambda: service(workspace).create(space_id, name, path, space_type, confirm)))
+
+
+@space_cli.command("adopt")
+def adopt(
+    space_id: str = typer.Option(..., "--id"),
+    name: str = typer.Option(..., "--name"),
+    path: str = typer.Option(..., "--path"),
+    space_type: str = typer.Option(..., "--type"),
+    workspace: str | None = typer.Option(None, "--workspace"),
+    confirm: bool = typer.Option(False, "--confirm"),
+) -> None:
+    emit(invoke(lambda: service(workspace).adopt(space_id, name, path, space_type, confirm)))