getting-started.md

Get Started Contributing

Set up your local environment to contribute to funkai.

Prerequisites

• Node.js >= 24.0.0
• pnpm 9.x (corepack enable to activate)
• Git
• Claude Code CLI (optional but recommended)

Steps

1. Fork and clone

gh repo fork joggrdocs/funkai --clone
cd funkai

2. Install dependencies

pnpm install

3. Verify the build

Run the full check suite to confirm everything works:

pnpm typecheck && pnpm build

4. Run tests

pnpm test

5. Understand the project

Read the project docs in this order:

1. AGENTS.md -- tech stack, project structure, available commands
2. contributing/concepts/architecture.md -- package ecosystem, design principles, data flow
3. contributing/concepts/tech-stack.md -- tools, libraries, and design rationale
4. Relevant standards in contributing/standards/ as needed
5. Package docs: @funkai/agents and @funkai/prompts

6. Set up Claude Code (optional)

The repo includes built-in configuration for Claude Code:

File	Purpose
AGENTS.md	Persona, project structure, tech stack, commands
CLAUDE.md	Symlink to AGENTS.md
.claude/settings.json	Claude Code settings and hooks

Verification

Confirm all checks pass:

pnpm typecheck && pnpm build
pnpm test

Troubleshooting

pnpm not found

Issue: Running pnpm returns "command not found."

Fix:

corepack enable

Lockfile mismatch after switching branches

Issue: Build or install fails after checking out a different branch.

Fix:

pnpm install

References

• Architecture