fsociety: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What This Is

fsociety is a multi-plugin marketplace for Claude Code offensive security plugins. Each plugin is a self-contained toolkit targeting a specific domain of penetration testing. The repo itself is NOT a Node.js application — there is no build step, no package.json, no test suite.

Requirements: Claude Code with MCP support, Kali Linux with Hexstrike MCP server, Node.js 18+.

Repository Architecture

This is a Claude Code plugin marketplace. The root contains the marketplace registry and individual plugin directories:

• .claude-plugin/marketplace.json — Plugin registry listing all available plugins with their source directories
• Each plugin directory (e.g., elliot/) is a self-contained Claude Code plugin with its own plugin.json, CLAUDE.md, commands, skills, agents, scripts, and hooks

Plugin Anatomy

Every plugin follows this structure:

plugin-name/
├── plugin.json           # Plugin definition (name, version, skills, agents)
├── CLAUDE.md             # Plugin-specific guidance for Claude Code
├── .gitignore            # Ignores runtime data files
├── commands/*.md         # Slash commands with YAML frontmatter
├── skills/*/SKILL.md     # Auto-activating skills with references/
├── agents/*.md           # Agent definitions with YAML frontmatter
├── scripts/*.js          # Node.js scripts (zero npm deps, stdlib only)
└── hooks/hooks.json      # Lifecycle hooks wiring scripts to events

Marketplace Registration

.claude-plugin/marketplace.json is the index. To register a plugin, add an entry to the plugins array:

{
  "name": "plugin-name",
  "description": "What it does.",
  "source": "./plugin-name/",
  "author": { "name": "author-name" }
}

Plugin JSON Schema

Each plugin's plugin.json:

{
  "name": "plugin-name",
  "version": "1.0.0",
  "description": "...",
  "author": { "name": "..." },
  "skills": ["./skills/", "./commands/"],
  "agents": ["./agents/agent-name.md"],
  "license": "MIT",
  "keywords": ["security", "pentest"]
}