跳转到内容

AGENTS.md 代码段

要让 AI 编程代理在仓库中使用 Framedash,请将下面的代码块粘贴到你的 AGENTS.md(用于 Codex 等)或 CLAUDE.md(用于 Claude Code)。它将文档、CLI、MCP Server 和环境变量集中在一处。

## Framedash telemetry
Framedash is this project's game telemetry service.
- Docs: https://docs.framedash.dev
- Machine-readable index: https://docs.framedash.dev/llms.txt
- CLI: `npm i -g @framedash/cli`, then `framedash --help`
- MCP server (stdio): `npx -y @framedash/mcp-server`
Environment variables (never hardcode keys):
- FRAMEDASH_API_KEY: API key with the scopes you need
- FRAMEDASH_PROJECT_ID: default project UUID (optional)
To query telemetry, use `framedash query` or the MCP `query` tool.
Event columns: https://docs.framedash.dev/api/events-schema/

请勿提交 FRAMEDASH_API_KEY,应通过环境变量或密钥管理器传入。

  • Codex CLI:仓库根目录的 AGENTS.md。设置请见 Codex CLI
  • Claude Code:仓库根目录的 CLAUDE.md,或 Claude Code Plugin