rasterstate/fj
rasterstate/fj
2
0
Fork 0
Code Issues Pull requests Actions 2 Packages Projects Releases 1 Wiki Activity
fj/docs/README.md
Stephen Way 71e536ffd8
Some checks are pending
ci / check (push) Waiting to run
Details
release / build (darwin-aarch64, macos, aarch64-apple-darwin) (push) Waiting to run
Details
release / build (darwin-x86_64, macos, x86_64-apple-darwin) (push) Waiting to run
Details
release / build (rust:1.95-bookworm, linux-x86_64, docker, x86_64-unknown-linux-gnu) (push) Waiting to run
Details
release / publish (push) Blocked by required conditions
Details
open-source readiness: release workflow, homebrew template, templates, compat doc 
Release infrastructure:
* .forgejo/workflows/release.yml: on v* tags, builds darwin-aarch64,
  darwin-x86_64, linux-x86_64 tarballs, computes SHA256SUMS, uploads to
  the Forgejo release, and writes a ready-to-commit fj.rb formula.
* dist/homebrew/fj.rb.tmpl + scripts/render-homebrew-formula.sh for
  local rendering. Publishes into rasterandstate/homebrew-tap.

Issue + PR templates:
* .forgejo/issue_template/{bug,feature,api-gap}.md so triage isn't
  guessing at the user's environment.
* .forgejo/pull_request_template.md with a fmt/clippy/test checklist
  and a "what to update" surface-changes section.

README demo scaffolding:
* scripts/record-demo.sh drives asciinema through a representative
  ~30s session covering --version, repo view (auto-detect), issue/pr
  list, api, --json-fields, browse.
* README has a commented-out asciicast embed waiting for the v0.1.0
  recording.

Compatibility:
* docs/compatibility.md: tested Forgejo versions, caveats for older
  Gitea (≤1.19), Forgejo-only endpoints we expose.
* `fj auth login` now probes /api/v1/version once and warns to stderr
  when the server reports a pre-7.x version. Parser is pure-fn tested
  (modern, old, unparseable cases).

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

924 B
Raw Permalink Blame History

fj documentation

  • architecture.md — module graph, layering rules, the HTTP funnel, pager + SIGINT, repo resolution, test strategy.
  • jq.md — the fj api --jq syntax. Dot paths, brackets, negative indices, pipes.
  • gh-to-fj.md — command-by-command mapping from gh.
  • compatibility.md — Forgejo version matrix and known caveats on older Gitea.
  • faq.md — common questions about tokens, hosts, debug, scripting, plugins.
  • troubleshooting.md — keychain prompts, hangs, 401 errors, --debug, pager opt-out, alias precedence, hook bypass.

For build/test workflow see ../CONTRIBUTING.md. For project conventions see ../CLAUDE.md. For security policy see ../SECURITY.md. For release notes see ../CHANGELOG.md.