hz README

The project's README from github.com/danielvaughn/hz. As one markdown file: README.md.

Huzzah

An experimental interface for building software by editing persistent pseudocode and synchronizing it with an AI-generated implementation.

setup

You need Node.js 22.19 or newer and access to a model provider supported by Pi.

  1. git clone https://github.com/danielvaughn/hz.git
  2. cd hz
  3. npm install
  4. Configure Pi using one of the options below.
  5. npm run dev

Open the url (should run on http://localhost:5173)

configure Pi

Huzzah uses Pi's provider, credential, and model configuration. It does not require a particular model vendor.

authenticate with an API key

Set an environment variable supported by your provider before starting Huzzah. For example:

export ANTHROPIC_API_KEY=sk-ant-...

Pi also recognizes credentials for OpenAI, Google, Azure OpenAI, Amazon Bedrock, and other supported providers.

authenticate with a subscription

Run Pi through the web app's local installation:

npx --workspace=poc pi

Enter /login, choose a provider, and complete its authentication flow. Exit Pi when authentication is complete, then start the web app with npm run dev.

choose a model

Set Pi's default provider and model in ~/.pi/agent/settings.json:

{
  "defaultProvider": "anthropic",
  "defaultModel": "claude-sonnet-4-5"
}

Use model IDs available to your configured provider. If no default is set, Pi falls back to the first authenticated model it finds. Huzzah currently uses Pi's low thinking level for reconciliation and semantic highlighting regardless of defaultThinkingLevel.

Pi also supports custom providers and local models such as Ollama, LM Studio, and vLLM through ~/.pi/agent/models.json.

Do not paste secrets or private source into Huzzah. Specs and current generated source are sent to your selected model provider, and accepted AI-generated JavaScript runs locally in a Web Worker. This is experimental containment, not a hostile-code sandbox.

ideas to get started

hz (danielvaughn/hz)

Searching Database…

201 ·GitHub
这是什么?Huzzah(“hz”)是一个实验性编辑器:你编写一份持久的伪代码规格说明,AI 让一个 JavaScript 实现与它持续保持同步,因此你是通过编辑规格而不是代码来构建软件。
这是像 VS Code 那样的代码编辑器,还是别的东西?它是另一种范式:你编辑伪代码规格,AI 重新生成并调和对应的 JavaScript 实现——它运行在本地 Web Worker 里,而不是手写出来的。
怎么把它跑起来?克隆仓库,运行 npm install,配置 Pi 的提供商/凭据设置,然后运行 npm run dev,在浏览器里启动 web 应用。
试用之前我需要什么?需要 Node.js 22.19 或更新版本,以及 Pi 支持的任意模型提供商——可以通过 API 密钥(OpenAI、Google、Azure OpenAI、Amazon Bedrock 等)、订阅登录,或 Ollama、LM Studio、vLLM 等本地模型进行认证。
AI 生成的代码有安全的沙箱隔离吗?并不完全——在 Web Worker 中运行生成的代码被描述为实验性的约束手段,并不是对恶意代码的真正隔离,所以不要把它当作安全边界来依赖。
它是给谁用的?它面向那些对以 AI 为中介、规格优先的软件开发方式(而不是传统的手写编码)感到好奇的开发者。
它在浏览器里运行,还是也有桌面应用?它主要通过 npm run dev 打开为 web 应用运行,仓库里也包含用于桌面版的 Electron 构建(dev:electron、build:electron)。
我的规格或代码会被发送出去吗?会——你的规格和当前生成的源码会发送给你配置的模型提供商,因此 README 警告不要把机密或私有源码粘贴进 Huzzah。
Pi 是什么?Pi 是 Huzzah 所依赖的提供商、凭据和模型配置层——它把具体的 AI 厂商抽象掉,让 Huzzah 能与众多不同的提供商和本地模型协作。
README 建议尝试什么样的项目?小而边界清晰的逻辑型应用,比如带折扣规则的购物车、回合制战斗系统、预算记录器、限流器和文字游戏——都是规格到代码工作流的绝佳测试用例。
我需要特定的 AI 模型或厂商吗?不需要——Huzzah 不要求特定的模型厂商;只要是 Pi 支持的即可,如果你没设默认模型,它会回退到第一个已认证的模型。
我可以用本地模型代替云端 API 吗?可以,Pi 支持自定义提供商和本地模型,比如通过 ~/.pi/agent/models.json 配置的 Ollama、LM Studio 和 vLLM。
Size
0.3 MB
Stars
201
Updated
CommitAug 23
Age
2mo
Commits · 90 Days