Skip to content

Meet fj: the native CLI for Fjord

fj is the native command-line client for Fjord. If you have used GitHub’s gh, it will feel familiar on the first command: the same verb-noun shape, the same “stay in the terminal” ergonomics, pointed at your Forgejo forge instead.

Install

brew tap rasterandstate/tap https://rasterhub.com/rasterstate/homebrew-tap
brew install fj

It installs from a Homebrew tap; see the docs for the current one-liner if it moves.

Sign in

fj authenticates with a personal access token you mint on your forge, and it stores that token in your OS keychain. It works against any Fjord forge and against a plain Forgejo instance you run yourself, so the CLI is free and needs no Fjord plan at all. A Fjord Account adds fj instances, which lists and switches between the forges on your account.

What you can do

The verbs cover the day-to-day forge workflow:

  • Repositories. List, clone, create, fork, and sync.
  • Pull requests. Open, review, check status, check out locally, and merge, including stacked branches.
  • Issues. Create, comment, label, and close.
  • Actions. Watch runs, read their logs, trigger a workflow, and manage secrets and variables.
  • Releases, labels, milestones, and tags. The bookkeeping, without the browser.
  • fj api. A raw authenticated request against anything else Forgejo exposes.

Because it is scriptable and reads cleanly in a pipeline, fj is as much for CI and automation as it is for interactive use. It complements Fjord Mobile: the app for review on the move, the CLI for everything you would rather script.

Get started

Read the fj docs

Install, authenticate, and the full command reference.

No forge yet? Sign up for Fjord, mint a token, and point fj at it.