fj/claude/README.md
Stephen Way 0a65a8eed8
Some checks are pending
ci / check (push) Waiting to run
docs: add Claude Code plugin (skill: fj)
Source of truth for the plugin lives in claude/ inside this repo. A
canonical mirror is at github.com/rasterandstate/fj-claude-plugin.

The skill activates when the user mentions fj, Forgejo, Gitea, or any
forge-side action. SKILL.md documents:
* the auto-detect convention (`-R` optional inside a clone)
* global flags (`--host`, `--debug`, `--no-pager`, `--json-fields`)
* the `--jq` syntax for `fj api`
* common workflows (PR review, issue triage, releases, code search)
* sharp edges (token TTY guard, --body in CI, gh-equivalence gaps)
* links back to docs/{architecture,gh-to-fj,compatibility,jq,troubleshooting}.md

Install in any Claude Code session:

  /plugin install rasterandstate/fj-claude-plugin

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 16:12:36 -07:00

1.8 KiB

fj Claude Code plugin

A Claude Code plugin that teaches Claude how to use fj, the CLI for Forgejo and Gitea-compatible instances.

The plugin ships a single skill (fj) that activates when the user mentions fj, Forgejo, Gitea, or any forge-side action (open a PR, list issues, cut a release, request a review, etc.) on a non-GitHub host.

Install

This directory is itself a complete Claude Code plugin. Two ways to install:

# From a local clone of the upstream fj repo:
/plugin install /path/to/fj/claude

# From the canonical mirror repo (preferred for users who aren't
# already cloning fj for development):
/plugin install rasterandstate/fj-claude-plugin

After install, the skill activates automatically when relevant.

Layout

claude/
├── .claude-plugin/
│   └── plugin.json       plugin manifest (name, version, keywords)
├── README.md             this file
└── skills/
    └── fj/
        └── SKILL.md      the skill body — what Claude reads

Updating

This claude/ directory is the source of truth, inside the fj repo at rasterhub.com/rasterstate/fj.

A mirror lives at github.com/rasterandstate/fj-claude-plugin, synced from this directory. To cut a new version:

  1. Bump version in .claude-plugin/plugin.json here.

  2. Update SKILL.md if new fj commands or workflows exist.

  3. Commit + push the fj repo.

  4. Sync the contents of claude/ over to the mirror repo and tag it:

    # From the fj repo root:
    rsync -av --delete --exclude=.git claude/ /path/to/fj-claude-plugin/
    cd /path/to/fj-claude-plugin
    git commit -am "sync from fj vX.Y.Z"
    git tag vX.Y.Z
    git push origin main vX.Y.Z
    

License

MIT, matching fj.