@idlekit/cli

中文文档
0.7.0发布于 2026/11/01MITES Module构建来源已验证

用于空闲游戏场景验证、模拟、调优和报告的idk CLI。

中文使用文档
文档目录3 节
  1. 巨额货币价值
  2. 运行时
  3. 文档

@idlekit / cli

idk 是空闲游戏设计评估的命令行界面。 使用它来验证场景、运行模拟、检查节奏、比较变量和调整策略。 官方支持v1: Bun >=1.4.2 只有。Node.js和浏览器运行时不是v1兼容性契约的一部分。

此注册表安装需要已发布的包。如果它返回 404,使用存储库 local-pack工作流,包括它对未发布的内部依赖项的覆盖,在单独的消费者项目中。

bun add -g @idlekit/cli

需要面包 >=1.4.2.

典型的流程:

idk init scenario --track personal --preset builder --out ./my-game-v1.json --name "Space Miner"
idk validate ./space-miner-v1.json
idk simulate ./space-miner-v1.json --format json
idk experience ./space-miner-v1.json --format json
idk evaluate ./space-miner-v1.json --format md

交互式脚手架和评审:

idk init scenario --wizard true --track personal --preset builder --out ./my-game-v1.json
idk review doctor
idk review evaluate ./space-miner-v1.json
idk review compare ./space-miner-v1.json ./space-miner-v1-compare-b.json
idk tune ./space-miner-v1.json --wizard true
idk experiment ./experiment-spec.json

Shell完成和运行状况检查:

source <(idk completions zsh)
idk doctor --format md
idk doctor --fix true --shell zsh
idk review doctor
idk setup plugin-trust --plugin ./custom-econ-plugin.ts --out ./.idk/plugin-trust.json

在这个仓库中工作的真实游戏示例:

bun run --cwd packages/cli dev -- experience ../../examples/tutorials/14-orbital-foundry-v1.json \
  --plugin ../../examples/plugins/custom-econ-plugin.ts \
  --allow-plugin true \
  --session-pattern twice-daily \
  --days 7 \
  --format json

巨额货币价值

compare, tune 和 balance 支持 --engine breakInfinity,旁边的 现有仿真命令。Number保持默认值; scenario.engine 不选择运行时。当场景数量超过时,使用显式标志 数字的范围,并使用引擎操作的自定义模型和目标。

使用所提供的构造插件数量 ctx.E。当改编一款游戏时 使用自己的Decimal库,通过使用 ctx.E.from(text) 在边界上,包括成本、回报和返回状态。 独立的游戏SDK和CLI包可以包含不同的Decimal构造器。

idk compare ./a.json ./b.json --engine breakInfinity --metric endNetWorth
idk tune ./a.json --tune ./tune.json --engine breakInfinity
idk balance ./workflow.json --engine breakInfinity --format md

Compare保留货币文本,同时调优目标,如 endNetWorthLog10 产生有限对数分数。重放构件保留了 选择引擎。Balance支持小数串货币目标和结果; CSV参数编辑,时间/计数指标和灵敏度旋钮仍然有限 数字。看到 平衡指南 用于目标语法和特定于引擎的新鲜度检查。breakEternity仍然是实验性的。

运行时

@idlekit/cli 是作为一个bunfirst CLI包来维护的。

  • 自动化路径: evaluate, compare --format json, experience --format md|json
  • 人工审核路径: review evaluate, review compare, review doctor
  • 引导安装路径: init scenario --wizard, tune --wizard, doctor --fix, setup completions
  • 推荐人体序列: init scenario --wizard -> review doctor -> review evaluate -> review compare -> tune --wizard

文档

版本与发布记录

@idlekit/cli 共发布 10 个版本,首次发布于 2026/10/11;过去 12 个月发布了 10 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.7.0latest2026/11/012 天前
0.6.02026/10/1816 天前
0.5.12026/10/1717 天前
0.5.02026/10/1618 天前
0.4.02026/10/1519 天前
0.3.12026/10/1321 天前

关于 @idlekit/cli 的常见问题

@idlekit/cli 是什么?

用于空闲游戏场景验证、模拟、调优和报告的idk CLI。

如何安装 @idlekit/cli?

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

@idlekit/cli 支持 TypeScript 吗?

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

@idlekit/cli 支持 ESM 还是 CommonJS?

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

@idlekit/cli 可以商用吗?

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

@idlekit/cli 还在维护吗?

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