Farmfe Guide

What it does

When your agent uses it

• Reviewing farm.config.ts
• Adding/configuring plugins
• Troubleshooting builds
• Implementing SSR

Example prompts

• “/farmfe-guide”

Requirements

• Compatibility (from SKILL.md): Farm ≥ 1.x. Node 16.18.0+. Uses pnpm as package manager.

What it can do on your machine

Read from SKILL.md and the folder at commit 2000ef8. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • pnpm

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  Links to these hosts (documentation or services it may open):

  • farmfe.org

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

• Compatibility

  Farm ≥ 1.x. Node 16.18.0+. Uses pnpm as package manager.

  From compatibility in the SKILL.md frontmatter.

Context cost

Farmfe Guide loads about 991 tokens when it runs, and up to ~13k if it reads all its reference files. Until then it costs about 105 tokens; SKILL.md has 220 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~105

When it runs · the whole SKILL.md, loaded when a task matches

~991

With references · SKILL.md plus every file in references/, read only if the agent opens them

~13k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from farm-fe/farm at commit 2000ef8, republished under its MIT licence (© farm-fe). 220 words, ~991 tokens.

name

farmfe-guide

description

Comprehensive Farm build-tool reference for AI agents. Use when writing or reviewing farm.config.ts, adding/configuring plugins, troubleshooting builds, implementing SSR or library mode, using the JavaScript API, writing Farm JS/Rust plugins, or authoring custom plugins from scratch. Covers all config options, official plugins, CLI commands, key features, and plugin authoring sourced from website/docs.

compatibility

Farm ≥ 1.x. Node 16.18.0+. Uses pnpm as package manager.

license

MIT

metadata.author

farm

metadata.version

1.2

references

skills/farmfe-guide/references/config.md, skills/farmfe-guide/references/cli.md, skills/farmfe-guide/references/plugins.md…

pnpm create farm@latest
# or with a template:
pnpm create farm my-app --template react

import { defineConfig } from '@farmfe/core';

export default defineConfig({
  plugins: ['@farmfe/plugin-react'],  // Rust plugin by package name
  compilation: {
    input:  { index: './index.html' },
    output: { targetEnv: 'browser-es2017' },
  },
  server: { port: 9000 },
});

© farm-fe, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 8 other files (references) in skills/farmfe-guide of farm-fe/farm.

• SKILL.md
• references/cli.md
• references/config.md
• references/features.md
• references/javascript-api.md
• references/js-plugin-api.md
• references/plugins.md
• references/recipes.md
• references/writing-plugins.md

Open the folder on GitHubat commit 2000ef8