Skip to content
3 min read

fj issue

Work with issues

fj issue [OPTIONS] <COMMAND>

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

fj issue list

List issues in a repo

fj issue list [OPTIONS]

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -s, --state <STATE> — Filter by state [default: open][possible values: open, closed, all]
  • -L, --limit <LIMIT> — Maximum number of issues to fetch [default: 30]
  • --page <PAGE> — Page of results to fetch [default: 1]
  • -l, --label <LABEL> — Filter by label
  • -a, --assignee <ASSIGNEE> — Filter by assignee
  • -S, --search <QUERY> — Search text to filter by
  • --json — Emit JSON instead of a table
  • --web — Open the issue list in your browser

fj issue view

View an issue by number

fj issue view [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

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

fj issue create

Create an issue

fj issue create [OPTIONS]

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -t, --title <TITLE> — Issue title
  • -b, --body <BODY> — Body. Use - to read from stdin. Omit to open $EDITOR
  • --web — Open the new issue in your browser after creating

fj issue edit

Edit an issue’s title, body, labels, or assignees

fj issue edit [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -t, --title <TITLE> — Issue title
  • -b, --body <BODY> — New body. Use - to read from stdin. Pass --body-editor to open $EDITOR
  • --body-editor — Open $EDITOR to edit the body inline (overrides --body)

fj issue close

Close an issue

fj issue close [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

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

fj issue reopen

Reopen a closed issue

fj issue reopen [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

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

fj issue delete

Delete an issue permanently (requires repo admin)

fj issue delete [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

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

fj issue pin

Pin an issue to the top of the issue list

fj issue pin [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

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

fj issue unpin

Unpin a pinned issue

fj issue unpin [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

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

fj issue comment

Add a comment

fj issue comment [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -b, --body <BODY> — Comment body. Use - to read from stdin. Omit to open $EDITOR

fj issue edit-comment

Edit a comment by id (comment ids come from issue view --comments)

fj issue edit-comment [OPTIONS] <COMMENT_ID>

Arguments

  • <COMMENT_ID> — Comment id (NOT the issue number). Find it via issue view --comments --json

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -b, --body <BODY> — New body. Use - to read from stdin. Omit to open $EDITOR

fj issue delete-comment

Delete a comment by id

fj issue delete-comment [OPTIONS] <COMMENT_ID>

Arguments

  • <COMMENT_ID> — Comment id

Options

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

fj issue develop

Create a branch tied to the issue

fj issue develop [OPTIONS] <NUMBER>

Arguments

  • <NUMBER> — Issue number

Options

  • -R, --repo <REPO> — Target repository as <owner>/<name>. Inferred from the git remote when omitted
  • -n, --name <NAME> — Branch name. Defaults to issue-<number>-<slug-of-title>
  • --base <BASE> — Base branch to start from. Defaults to the repo’s default branch
  • --dry-run — Just print the branch name; don’t run git
Contributors
  • Stephen Way