Skip to content
进入工作台

Project Init 用户手册

公开分发状态

Seed Contract v2.1 已发布

等待复核

公开 Git 稳定线为 v0.2.31,默认 Python Kit 为 mawflow-seed-kit 2.1.1。版本来自统一 Product Facts,不再由本页面手工维护。

公开 Git
v0.2.31
Seed Kit
2.1.1
核验状态
已过核验周期
事实来源
构建时快照
查看兼容与边界
  • Python:>=3.11
  • Git:>=2.30
  • Seed 是开源项目协作规范,不是产品档位或在线工作台。
  • 部分事实已超过核验周期,当前展示最后一次可信快照。

查看安装步骤GitHub 开源仓Gitee 开源仓

mawflow project init 用来从 MAWflow Seed 模板初始化一个本地项目。它是 Host Base CLI 提供的便捷入口,不会改变 Seed 的开源使用方式:你仍然可以直接从公开 GitHub、Gitee 或任意 Git URL clone Seed,不需要授权码,也不必须通过 Host Base 才能使用 Seed。

最短命令形式是 mawflow project init my-project。Seed Contract v2.1 使用已发布的 mawflow-seed-kit 2.1.1 与公开 Git v0.2.31,package、公开 Git tag 和项目 lock 共享 BOM 与契约指纹。

推荐路径

先安装 @mawflow/cli,再初始化项目:

bash
npm install -g @mawflow/cli --registry=https://mawflow.com/npm/
mawflow
mawflow project init my-project
cd my-project

默认会从官网 Python 包源获取官方模板包:

text
https://mawflow.com/packages/simple

默认模板包名:

text
mawflow-seed-kit

常用命令

使用默认官方模板包:

bash
mawflow project init my-project

固定当前默认 package 模板版本:

bash
mawflow project init my-project --template-version 2.0.0 --profile web-api

从 GitHub 稳定 tag 初始化:

bash
mawflow project init my-project --source github --repo mawflow/mawflow-seed --ref v0.2.31 --profile web-api

从 Gitee 使用公开 Seed:

bash
mawflow project init my-project --source gitee --repo mawflow/mawflow-seed --ref v0.2.31 --profile web-api

从任意 Git URL:

bash
mawflow project init my-project --source git --repo https://github.com/mawflow/mawflow-seed.git --ref v0.2.31 --profile web-api

从本机模板目录:

bash
mawflow project init my-project --source local --path /path/to/seed-template

指定目标目录:

bash
mawflow project init my-project --target-dir /path/to/my-project

跳过 Git 初始化:

bash
mawflow project init my-project --no-git-init

初始化后会写入什么

成功后,项目目录会包含 Seed 模板文件,并写入:

text
.maw/template-source.yaml
.maw/project.yaml

template-source.yaml 记录模板来源、版本、模板树 checksum、仓库/ref 或本机路径指纹,不写入可提交的本机绝对路径。project.yaml 记录项目名称和项目 key。成功 JSON 还会返回 created files、首次检查结果、next steps 和 rollback hint。

目录和安全规则

  • 默认目标目录是当前目录下的项目名。
  • 如果默认目标目录不在你的 home 目录下,命令会拒绝;需要写到其它位置时,请显式传入 --target-dir
  • 目标目录已存在且非空时默认拒绝,避免覆盖已有项目。
  • 非空目录始终拒绝初始化;已有项目必须走 mawflow project adopt/upgrade 一次性迁移。
  • 写入先发生在同级临时目录,模板检查和首次检查通过后才原子移动到目标目录;失败时清理本次临时内容,不修改已有目录。
  • 初始化不会登录账号,不会启动服务,不会注册系统服务,也不会写入登录授权码或供应商密钥。
  • 模板包含 .local、私钥、授权码、真实客户资料或供应商密钥形态时,初始化会拒绝。

Seed 的公开访问边界

如果你只是想看 Seed,可以直接打开 GitHubGiteev0.2.31 是当前外部稳定线。目标目录已存在且非空时 CLI 始终拒绝覆盖。

下一步