Skip to content
2 min read

fj release

Work with releases

fj release [OPTIONS] <COMMAND>

Every command also accepts the global flags: --host, --debug, --no-pager, --json-fields.

fj release list

List releases on a repository

fj release list [OPTIONS]

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -L, --limit <LIMIT> — Maximum number of releases to fetch [default: 30]
  • --json — Emit JSON instead of a table
  • --web — Open the release in your browser

fj release view

View a release by tag

fj release view [OPTIONS] <TAG>

Arguments

  • <TAG> — Release tag

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • --json — Emit JSON instead of a table
  • --web — Open the release in your browser

fj release create

Create a release

fj release create [OPTIONS] <TAG>

Arguments

  • <TAG> — Release tag

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -t, --title <TITLE> — Release title
  • -b, --body <BODY> — Release notes (use - for stdin, omit to open $EDITOR)
  • --target <TARGET> — Target commitish (branch or SHA). Defaults to default branch
  • --draft — Save as a draft instead of publishing
  • --prerelease — Mark as a prerelease
  • --asset <FILE> — Files to upload as assets (repeatable)

fj release edit

Edit a release

fj release edit [OPTIONS] <TAG>

Arguments

  • <TAG> — Release tag

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -t, --title <TITLE> — Release title
  • -b, --body <BODY> — Release notes (use - for stdin, omit to open $EDITOR)
  • --draft <DRAFT> — Save as a draft instead of publishing [possible values: true, false]
  • --prerelease <PRERELEASE> — Mark as a prerelease [possible values: true, false]
  • --body-editor — Edit the release notes in $EDITOR

fj release delete

Delete a release

fj release delete [OPTIONS] <TAG>

Arguments

  • <TAG> — Release tag

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -y, --yes — Skip the confirmation prompt

fj release upload

Upload an asset file to a release

fj release upload [OPTIONS] <TAG> [FILES]...

Arguments

  • <TAG> — Release tag
  • [FILES]... — File paths to upload

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted

fj release download

Download a release asset by name

fj release download [OPTIONS] <TAG>

Arguments

  • <TAG> — Release tag

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -n, --name <NAME> — Asset name. If omitted, all assets are downloaded
  • -o, --output-dir <OUTPUT_DIR> — Output directory (default: cwd)

fj release delete-asset

Delete a single asset from a release by name

fj release delete-asset [OPTIONS] <TAG> <ASSET>

Arguments

  • <TAG> — Release tag
  • <ASSET> — Name of the asset to delete

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -y, --yes — Skip the confirmation prompt
Contributors
  • Stephen Way