Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/drew-daniels/jg

Utility functions for Jira and Git
https://github.com/drew-daniels/jg
cli git github jira
Last synced: 28 days ago
JSON representation
Utility functions for Jira and Git
Host: GitHub
URL: https://github.com/drew-daniels/jg
Owner: Drew-Daniels
Created: 2024-11-28T14:44:20.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-12-08T03:56:14.000Z (29 days ago)
Last Synced: 2024-12-08T04:24:08.619Z (29 days ago)
Topics: cli, git, github, jira
Language: TypeScript
Homepage:
Size: 256 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # `jgit`

Utility functions for Jira and Git

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/jgit.svg)](https://npmjs.org/package/jgit)

[![Downloads/week](https://img.shields.io/npm/dw/jgit.svg)](https://npmjs.org/package/jgit)

* [`jgit`](#jgit)

* [Setup](#setup)

* [Your Organization's Jira instance](#your-organizations-jira-instance)

* [Your Jira API token https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/](#your-jira-api-token-httpssupportatlassiancomatlassian-accountdocsmanage-api-tokens-for-your-atlassian-account)

* [Your Organization's email address - Ex. @.com](#your-organizations-email-address---ex-firstnamelastnameorganizationcom)

* [Usage](#usage)

* [Commands](#commands)

# Setup

## GitHub API Auth

You will need to export a GitHub OAuth Token to authenticate with the GitHub API.

https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens

```sh

export GITHUB_OAUTH_TOKEN="YOUR_GITHUB_OAUTH_TOKEN"

```

## Jira API Auth

You will need the following env vars set in your shell to authenticate with the Jira API:

```sh

# Your Organization's Jira instance

export JIRA_HOSTNAME="https://jira.example.com"

# Your Jira API token https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/

export JIRA_API_TOKEN="YOUR_JIRA_API_TOKEN"

# Your Organization's email address - Ex. @.com

export JIRA_API_EMAIL="YOUR_JIRA_EMAIL"

```

# Usage

```sh-session

$ npm install -g jgit

$ jg COMMAND

running command...

$ jg (--version)

jgit/0.0.5 darwin-arm64 node-v22.5.1

$ jg --help [COMMAND]

USAGE

  $ jg COMMAND

...

```

# Commands

* [`jg bname [ISSUEIDORKEY]`](#jg-bname-issueidorkey)

* [`jg cc [ISSUEIDORKEY]`](#jg-cc-issueidorkey)

* [`jg find [ISSUEIDORKEY]`](#jg-find-issueidorkey)

* [`jg help [COMMAND]`](#jg-help-command)

* [`jg id`](#jg-id)

* [`jg key`](#jg-key)

* [`jg plugins`](#jg-plugins)

* [`jg plugins add PLUGIN`](#jg-plugins-add-plugin)

* [`jg plugins:inspect PLUGIN...`](#jg-pluginsinspect-plugin)

* [`jg plugins install PLUGIN`](#jg-plugins-install-plugin)

* [`jg plugins link PATH`](#jg-plugins-link-path)

* [`jg plugins remove [PLUGIN]`](#jg-plugins-remove-plugin)

* [`jg plugins reset`](#jg-plugins-reset)

* [`jg plugins uninstall [PLUGIN]`](#jg-plugins-uninstall-plugin)

* [`jg plugins unlink [PLUGIN]`](#jg-plugins-unlink-plugin)

* [`jg plugins update`](#jg-plugins-update)

* [`jg pr [ISSUEIDORKEY]`](#jg-pr-issueidorkey)

* [`jg url [ISSUEIDORKEY]`](#jg-url-issueidorkey)

## `jg bname [ISSUEIDORKEY]`

Generates a Git branch name from a Jira Issue ID/Key

```

USAGE

  $ jg bname [ISSUEIDORKEY] [--json] [-h] [-q -c]

ARGUMENTS

  ISSUEIDORKEY  Jira Issue ID or Key

FLAGS

  -c, --clipboard  Copy to clipboard

  -h, --help       Show help

  -q, --quiet      Suppress output

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Generates a Git branch name from a Jira Issue ID/Key

EXAMPLES

  $ jg bname

  $ jg bname --clipboard

  $ jg bname --clipboard --quiet

  $ jg bname --json

```

_See code: [src/commands/bname/index.ts](https://github.com/Drew-Daniels/jg/blob/v0.0.5/src/commands/bname/index.ts)_

## `jg cc [ISSUEIDORKEY]`

Generates a Conventional Commit Message from a Jira Issue ID/Key

```

USAGE

  $ jg cc [ISSUEIDORKEY] [--json] [-h] [-q -c]

ARGUMENTS

  ISSUEIDORKEY  Jira Issue ID or Key

FLAGS

  -c, --clipboard  Copy to clipboard

  -h, --help       Show help

  -q, --quiet      Suppress output

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Generates a Conventional Commit Message from a Jira Issue ID/Key

EXAMPLES

  $ jg cc

  $ jg cc --clipboard

  $ jg cc --clipboard --quiet

  $ jg cc --json

```

_See code: [src/commands/cc/index.ts](https://github.com/Drew-Daniels/jg/blob/v0.0.5/src/commands/cc/index.ts)_

## `jg find [ISSUEIDORKEY]`

Finds the latest GH PR for a Jira ticket

```

USAGE

  $ jg find [ISSUEIDORKEY] [--json] [-h] [-q -c]

ARGUMENTS

  ISSUEIDORKEY  Jira Issue ID or Key

FLAGS

  -c, --clipboard  Copy to clipboard

  -h, --help       Show help

  -q, --quiet      Suppress output

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Finds the latest GH PR for a Jira ticket

EXAMPLES

  $ jg find

  $ jg find --clipboard

  $ jg find --clipboard --quiet

  $ jg find --json

```

_See code: [src/commands/find/index.ts](https://github.com/Drew-Daniels/jg/blob/v0.0.5/src/commands/find/index.ts)_

## `jg help [COMMAND]`

Display help for jg.

```

USAGE

  $ jg help [COMMAND...] [-n]

ARGUMENTS

  COMMAND...  Command to show help for.

FLAGS

  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION

  Display help for jg.

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.18/src/commands/help.ts)_

## `jg id`

Returns Jira Issue ID from current Git branch

```

USAGE

  $ jg id [--json] [-h] [-q -c]

FLAGS

  -c, --clipboard  Copy to clipboard

  -h, --help       Show help

  -q, --quiet      Suppress output

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Returns Jira Issue ID from current Git branch

EXAMPLES

  $ jg id

  $ jg id --clipboard

  $ jg id --clipboard --quiet

  $ jg id --json

```

_See code: [src/commands/id/index.ts](https://github.com/Drew-Daniels/jg/blob/v0.0.5/src/commands/id/index.ts)_

## `jg key`

Returns Jira Issue Key from current Git branch

```

USAGE

  $ jg key [--json] [-h] [-q -c]

FLAGS

  -c, --clipboard  Copy to clipboard

  -h, --help       Show help

  -q, --quiet      Suppress output

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Returns Jira Issue Key from current Git branch

EXAMPLES

  $ jg key

  $ jg key --clipboard

  $ jg key --clipboard --quiet

  $ jg key --json

```

_See code: [src/commands/key/index.ts](https://github.com/Drew-Daniels/jg/blob/v0.0.5/src/commands/key/index.ts)_

## `jg plugins`

List installed plugins.

```

USAGE

  $ jg plugins [--json] [--core]

FLAGS

  --core  Show core plugins.

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  List installed plugins.

EXAMPLES

  $ jg plugins

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/index.ts)_

## `jg plugins add PLUGIN`

Installs a plugin into jg.

```

USAGE

  $ jg plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS

  PLUGIN...  Plugin to install.

FLAGS

  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.

  -h, --help     Show CLI help.

  -s, --silent   Silences npm output.

  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Installs a plugin into jg.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the JG_NPM_LOG_LEVEL environment variable to set the npm loglevel.

  Use the JG_NPM_REGISTRY environment variable to set the npm registry.

ALIASES

  $ jg plugins add

EXAMPLES

  Install a plugin from npm registry.

    $ jg plugins add myplugin

  Install a plugin from a github url.

    $ jg plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ jg plugins add someuser/someplugin

```

## `jg plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```

USAGE

  $ jg plugins inspect PLUGIN...

ARGUMENTS

  PLUGIN...  [default: .] Plugin to inspect.

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Displays installation properties of a plugin.

EXAMPLES

  $ jg plugins inspect myplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/inspect.ts)_

## `jg plugins install PLUGIN`

Installs a plugin into jg.

```

USAGE

  $ jg plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS

  PLUGIN...  Plugin to install.

FLAGS

  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.

  -h, --help     Show CLI help.

  -s, --silent   Silences npm output.

  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Installs a plugin into jg.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the JG_NPM_LOG_LEVEL environment variable to set the npm loglevel.

  Use the JG_NPM_REGISTRY environment variable to set the npm registry.

ALIASES

  $ jg plugins add

EXAMPLES

  Install a plugin from npm registry.

    $ jg plugins install myplugin

  Install a plugin from a github url.

    $ jg plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ jg plugins install someuser/someplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/install.ts)_

## `jg plugins link PATH`

Links a plugin into the CLI for development.

```

USAGE

  $ jg plugins link PATH [-h] [--install] [-v]

ARGUMENTS

  PATH  [default: .] path to plugin

FLAGS

  -h, --help          Show CLI help.

  -v, --verbose

      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION

  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'

  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES

  $ jg plugins link myplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/link.ts)_

## `jg plugins remove [PLUGIN]`

Removes a plugin from the CLI.

```

USAGE

  $ jg plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS

  PLUGIN...  plugin to uninstall

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Removes a plugin from the CLI.

ALIASES

  $ jg plugins unlink

  $ jg plugins remove

EXAMPLES

  $ jg plugins remove myplugin

```

## `jg plugins reset`

Remove all user-installed and linked plugins.

```

USAGE

  $ jg plugins reset [--hard] [--reinstall]

FLAGS

  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.

  --reinstall  Reinstall all plugins after uninstalling.

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/reset.ts)_

## `jg plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

```

USAGE

  $ jg plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS

  PLUGIN...  plugin to uninstall

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Removes a plugin from the CLI.

ALIASES

  $ jg plugins unlink

  $ jg plugins remove

EXAMPLES

  $ jg plugins uninstall myplugin

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/uninstall.ts)_

## `jg plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

```

USAGE

  $ jg plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS

  PLUGIN...  plugin to uninstall

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Removes a plugin from the CLI.

ALIASES

  $ jg plugins unlink

  $ jg plugins remove

EXAMPLES

  $ jg plugins unlink myplugin

```

## `jg plugins update`

Update installed plugins.

```

USAGE

  $ jg plugins update [-h] [-v]

FLAGS

  -h, --help     Show CLI help.

  -v, --verbose

DESCRIPTION

  Update installed plugins.

```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.17/src/commands/plugins/update.ts)_

## `jg pr [ISSUEIDORKEY]`

Generates a Slack Message with a Link to a Jira Issue and corresponding GitHub link

```

USAGE

  $ jg pr [ISSUEIDORKEY] [--json] [-h] [-q -c]

ARGUMENTS

  ISSUEIDORKEY  file to read

FLAGS

  -c, --clipboard  Copy to clipboard

  -h, --help       Show help

  -q, --quiet      Suppress output

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Generates a Slack Message with a Link to a Jira Issue and corresponding GitHub link

EXAMPLES

  $ jg pr

  $ jg pr --clipboard

  $ jg pr --clipboard --quiet

  $ jg pr --json

```

_See code: [src/commands/pr/index.ts](https://github.com/Drew-Daniels/jg/blob/v0.0.5/src/commands/pr/index.ts)_

## `jg url [ISSUEIDORKEY]`

Returns a URL to a Jira Issue

```

USAGE

  $ jg url [ISSUEIDORKEY] [--json] [-h] [-q -c] [-m]

ARGUMENTS

  ISSUEIDORKEY  Jira Issue ID or Key

FLAGS

  -c, --clipboard  Copy to clipboard

  -h, --help       Show help

  -m, --markdown   Get Markdown Link to Jira Issue

  -q, --quiet      Suppress output

GLOBAL FLAGS

  --json  Format output as json.

DESCRIPTION

  Returns a URL to a Jira Issue

EXAMPLES

  $ jg url

  $ jg url --clipboard

  $ jg url --clipboard --quiet

  $ jg url --json

```

_See code: [src/commands/url/index.ts](https://github.com/Drew-Daniels/jg/blob/v0.0.5/src/commands/url/index.ts)_