The easiest way to start a new Fedify project is to use the fedify init command. It creates a new directory with a minimal Fedify project template.

First of all, you need to have the fedify command, the Fedify CLI toolchain, installed on your system. If you haven't installed it yet, please follow the following instructions:

::: code-group

npm install -g @fedify/cli

brew install fedify

scoop install fedify

bun install -g @fedify/cli

deno install -gA --unstable-fs --unstable-kv -n fedify jsr:@fedify/cli

:::

If you use Deno earlier than 2.7.0, add --unstable-temporal to the Deno installation command above.

There are other ways to install the fedify command. Please refer to the Installation section in the CLI toolchain docs.

After installing the fedify command, you can create a new Fedify project by running the following command:

fedify init your-project-dir

The above command will start a wizard to guide you through the project setup. You can choose the JavaScript runtime, the package manager, and the web framework you want to integrate Fedify with, and so on. After the wizard finishes, you will have a new Fedify project in the your-project-dir directory.

For more information about the fedify init command, please refer to the fedify init section in the CLI toolchain docs.

If you don't want to install the fedify CLI globally, you can use @fedify/create directly:

::: code-group

npm init @fedify your-project-dir

pnpm create @fedify your-project-dir

yarn create @fedify your-project-dir

bunx @fedify/create your-project-dir

:::

This works the same way as fedify init and will guide you through the same project setup wizard.

Fedify is available on JSR for Deno and on npm for Bun and Node.js.

Deno is the primary runtime for Fedify. As a prerequisite, you need to have Deno 2.0.0 or later installed on your system. Then you can install Fedify via the following command:

deno add jsr:@fedify/fedify

Fedify requires the Temporal API. On Deno 2.7.0 or later, it is stable and no extra setting is needed. On Deno versions earlier than 2.7.0, add "temporal" to the "unstable" field in deno.json:

{
  "imports": {
    "@fedify/fedify": "jsr:@fedify/fedify"
  },
  "unstable": ["temporal"]
}

Fedify can also be used in Bun. You can install it via the following command:

bun add @fedify/fedify

Fedify can also be used in Node.js. As a prerequisite, you need to have Node.js 22.0.0 or later installed on your system. Then you can install Fedify via the following command:

::: code-group

npm add @fedify/fedify

pnpm add @fedify/fedify

yarn add @fedify/fedify

:::

We recommend using ESM with Fedify by adding "type": "module" to the package.json file. While Fedify also supports CommonJS for legacy compatibility, ESM is the preferred approach:

{
  "type": "module",
  "dependencies": {
    "@fedify/fedify": "^1.8.1"
  }
}

fedify init configures Visual Studio Code for you out of the box. Setting up Zed takes a few extra steps because fedify init does not generate .zed/ files yet.

For Deno projects, fedify init writes a .vscode/extensions.json that recommends the Deno extension:

{ "recommendations": ["denoland.vscode-deno"] }

The matching .vscode/settings.json turns on Deno's language server and sets it as the default formatter for JavaScript and TypeScript:

{
  "deno.enable": true,
  "deno.unstable": true,
  "editor.detectIndentation": false,
  "editor.indentSize": 2,
  "editor.insertSpaces": true,
  "[typescript]": {
    "editor.defaultFormatter": "denoland.vscode-deno",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.sortImports": "always"
    }
  }
  // The same block applies to [javascript], [javascriptreact], and
  // [typescriptreact]; [json] and [jsonc] use "vscode.json-language-features".
}

Deno's Set up your environment guide covers other editors and shells.

For Node.js/Bun projects, fedify init writes a .vscode/extensions.json that recommends the Oxc extension:

{ "recommendations": ["oxc.oxc-vscode"] }

The matching .vscode/settings.json sets Oxfmt as the default formatter and enables Oxc's fix-all action on save:

{
  "editor.detectIndentation": false,
  "editor.indentSize": 2,
  "editor.insertSpaces": true,
  "oxc.fmt.configPath": ".oxfmtrc.json",
  "[typescript]": {
    "editor.defaultFormatter": "oxc.oxc-vscode",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll.oxc": "always"
    }
  }
  // The same block applies to [javascript], [javascriptreact],
  // [typescriptreact], [json], and [jsonc].
}

For Deno projects, create .zed/settings.json that enables the Deno language server and uses it as the formatter for TypeScript and JavaScript. The ! prefix disables the bundled TypeScript and ESLint servers so they do not compete with Deno:

{
  "lsp": {
    "deno": {
      "settings": { "deno": { "enable": true } }
    }
  },
  "languages": {
    "TypeScript": {
      "formatter": [
        { "language_server": { "name": "deno" } }
      ],
      "language_servers": [
        "deno",
        "!typescript-language-server",
        "!vtsls",
        "!eslint",
        "!biome",
        "..."
      ]
    }
    // The same block applies to TSX and JavaScript.
  }
}

Zed's Deno language docs cover the available options. Hackers' Pub is a real-world reference.

For Node.js/Bun projects, Zed enables its bundled TypeScript language server out of the box; the typical addition is wiring up Oxc for formatting and lint fixes. See Zed's TypeScript language docs for setup. Set Oxc as the language server and turn on its fix-all action on format:

{
  "language_servers": ["oxc", "..."],
  "code_actions_on_format": {
    "source.fixAll.oxc": true
  }
}

fedify init configures the @fedify/lint plugin automatically: Deno projects pick it up through lint.plugins in deno.json, and Node.js/Bun projects through a generated .oxlintrc.json using @fedify/lint/oxlint. For the full rule list, configuration options, and how to run the linter, see the Linting chapter.

This skill is available since Fedify 2.2.0.

Fedify ships a Markdown skill file that AI coding assistants such as Claude Code, Codex, or OpenCode can load to learn Fedify's APIs, common pitfalls, and recommended patterns. The file lives inside the @fedify/fedify package itself, so the only remaining step is exposing it to your agent's skills directory.

Install the Fedify plugin from the Claude Code marketplace. The plugin works with any runtime and adds six slash commands, two specialized agents, and the full Fedify skill:

/plugin marketplace add fedify-dev/fedify
/plugin install fedify@fedify

Use skills-npm, a third-party tool by Anthony Fu (it is not a Fedify package), that scans node_modules for packages exposing the agents.skills field in their package.json and links them into your agent's skills directory on every install.

1. Install skills-npm as a dev dependency:

   ::: code-group

   npm add -D skills-npm

   pnpm add -D skills-npm

   yarn add -D skills-npm

   bun add -D skills-npm

   :::

2. Add a prepare script to your package.json so it runs after every install:

   {
     "scripts": {
       "prepare": "skills-npm"
     }
   }

3. Reinstall once. The Fedify skill appears at .claude/skills/fedify/ (and similar locations for other supported agents).

The same script picks up other Fedify packages and any third-party npm packages that adopt the convention.

Install the skill by hand:

1. Pick your agent's skills directory. For Claude Code, this is .claude/skills/fedify/.

2. Download SKILL.md from the Fedify repository:

   mkdir -p .claude/skills/fedify
   curl -L -o .claude/skills/fedify/SKILL.md \
     https://raw.githubusercontent.com/fedify-dev/fedify/main/claude-plugin/skills/fedify/SKILL.md

3. Either commit the file or add it to .gitignore, depending on your team's preference.