AI agents knowledge base

Curated documentation pack that gives AI coding assistants, Claude, ChatGPT, Cursor, and others, working knowledge of the Piko framework.

Overview

The agents plugin is a static documentation bundle, not a runtime service. It ships an AGENTS.md workflow guide (project-context capture, task classification, code generation) and a SKILL.md variant with YAML frontmatter for the Claude skill system. It also includes a .claude-plugin/plugin.json manifest for Claude Code, an .lsp.json editor config that launches pikopls for .pk and .pkc files, and reference documents spanning the .pk and .pkc formats, routing, server actions, WDK services, and tooling.

The whole bundle is go:embed-ed inside the piko CLI. The CLI writes these files into your project or Claude skills directory when you scaffold a project or run piko agents install. Because the docs ship inside the binary, an install always matches the exact CLI version you have, with no separate download or version drift.

Installation

The piko CLI installs and updates the bundle.

piko new myproject       # scaffolds AGENTS.md and references/ when you enable the agents toggle
piko agents install      # configures one or more AI tools (update is an alias)

piko new writes the project-level files (AGENTS.md and references/) when you select the agents option in the wizard. To configure other tools or refresh the docs, run piko agents install.

piko agents install opens an interactive prompt that offers two targets:

  • Claude Code. Installs SKILL.md and references/ to ~/.claude/skills/piko. This is global, so every Piko project on your machine sees the skill.
  • AGENTS.md. Installs AGENTS.md and references/ into the current project for Codex, Cursor, Copilot, Windsurf, and other AGENTS.md tools.

The same reference documents back both targets. Each install removes the destination references/ directory before writing, so renamed or deleted files do not linger after a Piko upgrade. Run piko agents install again after upgrading the CLI to refresh the docs. When you install the project-level AGENTS.md, the prompt offers to add the agent files to .gitignore.

update is an alias for install. There is no non-interactive flag. To remove a bundle, run piko agents uninstall, which lists the installed targets and can also strip the agent entries from .gitignore.

Files

FilePurpose
AGENTS.mdPrimary workflow guide for AI coding assistants.
SKILL.mdClaude skill-system variant with YAML frontmatter.
.claude-plugin/plugin.jsonPlugin metadata for Claude Code.
.lsp.jsonEditor config that launches pikopls for .pk and .pkc files.
references/*.mdFramework reference documents (see below).

Reference documents

Primary references: pk-file-format.md, pkc-components.md, template-syntax.md, partials-and-slots.md, routing.md, server-actions.md.

Supplemental references: project-structure.md, styling.md, i18n.md, collections.md, cli-reference.md, do-dont-patterns.md, examples.md, pk-javascript-interactive.md.

WDK and infrastructure references: wdk-data.md, querier.md, wdk-email-events.md, wdk-security.md, wdk-media.md, wdk-llm.md, testing.md, configuration.md.

See also

Sibling integrations:

  • VS Code, official VS Code extension with bundled pikopls.
  • IntelliJ IDEA, JetBrains plugin for GoLand and IntelliJ Ultimate.

Framework docs: