@getquick/site

中文文档
0.44.1发布于 2026/11/14MITES Module近 30 天下载 8689

Shared tooling for GETQUICK sites: the gq CLI

原始使用文档
文档目录7 节
  1. Quick start
  2. Generate a content site
  3. Use an existing site
  4. Redeploy one package
  5. Documentation
  6. Current status
  7. License

gq-site

Shared tooling for GETQUICK sites, published to public npm as @getquick/site: one gq CLI, configured by each site's own gq.ops.json.

The blueprint generates and synchronizes managed files, provisions Ploi and Cloudflare, runs local CMS and workspace checks, and handles releases, database backups and live-to-local sync. Secrets are injected per command through Sigillo; generation and sync need no network access or secrets.

Quick start

For site setup, use the blueprint's Node pin (currently 24.21.0) and the pnpm version in the site's packageManager. The CLI alone supports Node 22.12.0+; that minimum is not enough for the site's full development toolchain. This repository's contributor requirements are in Development.

Generate a content site

pnpm dlx @getquick/site new acme --project acme --variant content
cd acme
# Activate the Node pin in .mise.toml or .nvmrc before installing.
pnpm install
pnpm exec gq sync --check

The target directory must be empty. gq new creates the CMS and Frontend app skeletons and prints the provisioning steps without running them. A content site's Frontend is Astro or TanStack Start, its choice: in a terminal gq new asks, and --framework astro|tanstack picks one (TanStack Start when omitted outside a terminal). See Frontend frameworks. See Generate and sync a site for ownership, adoption, and handling sync conflicts, then Local development or Provisioning and deployment.

Use an existing site

Pin an exact version in the site's root devDependencies; no registry login is needed:

pnpm add --save-dev --save-exact @getquick/site
pnpm exec gq --help

Configure gq.ops.json before running site commands. A manifest without schemaVersion, or release settings in a shop-devtools.config.mjs, is migrated by gq sync --manifest: see the manifest reference and the release reference.

Redeploy one package

To ship a new build of one GETQUICK Composer package (such as GQ Design's main, required as "dev-main as 0.5.99") to a Site's CMS without a tagged release, run from a clean tree of the Site:

pnpm release:package getquick/gq-design
# = gq sigillo run staging -- gq release package getquick/gq-design

It updates that package in apps/cms/composer.lock with the registry login, syncs the current version, commits, and deploys the commit with gq ploi release. Push the commit afterwards. See release package and a Site on a branch.

Documentation

These guides and references ship with the npm package. The Ploi API inventory is a dated research snapshot, not the current command reference.

Current status

Phases 1–3 of the rollout (extraction, content-site generation, and adoption by an existing content site) have passed. Managed-file changes originate here; a site takes them by bumping its pin and running gq sync. gq new --variant commerce generates a commerce site with the storefront Runtime mounted, whose install needs a GitHub Packages token (ADR 0017); gq site check is its readiness gate (ADR 0021), and commerce adoption and fleet rollout are gated work. See the rollout record for evidence and remaining gates, and ADR 0001 for the blueprint decision.

License

MIT

版本与发布记录

@getquick/site 共发布 80 个版本,首次发布于 2026/10/01;过去 12 个月发布了 80 个版本。

版本发布日期距今
0.44.1latest2026/11/142 天前
0.44.02026/11/132 天前
0.43.12026/11/133 天前
0.43.02026/11/133 天前
0.42.02026/11/133 天前
0.41.12026/11/133 天前

关于 @getquick/site 的常见问题

@getquick/site 是什么?

Shared tooling for GETQUICK sites: the gq CLI

如何安装 @getquick/site?

在项目目录运行 npm install @getquick/site,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 gq,可以用 npx gq 直接运行。

@getquick/site 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/getquick__site 是否存在。

@getquick/site 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@getquick/site 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.12.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getquick/site 可以商用吗?

@getquick/site 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@getquick/site 的下载量有多少?

根据 npm 官方下载统计,@getquick/site 在 2026/10/17 – 2026/11/15 这 30 天内被下载 8,689 次,日均约 290 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getquick/site 还在维护吗?

最新版本 0.44.1 发布于 2026/11/14(2 天前);至今共发布 80 个版本,其中过去 12 个月发布了 80 个;首次发布于 2026/10/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。