tcgit v1.0.25

tcgit

git wrapper for issue-based workflow

• Usage
• Workflow
• Commands

Usage

$ npm install -g tcgit
$ tcgit COMMAND
running command...
$ tcgit (-v|--version|version)
tcgit/2.1.2 darwin-x64 node-v14.17.0
$ tcgit --help [COMMAND]
USAGE
  $ tcgit COMMAND
...

Workflow

1. Create a new issue.

$ gh issue create

1. Create a branch from an issue title (here is ticket #1.)

$ tcgit branch 1

3. Run tcgit refresh regularly to refresh the main base, if you work with other devs.
4. When you're done, merge with main by running tcgit merge on the branch.

Commands

• tcgit autocomplete [SHELL]
• tcgit branch [ISSUEID]
• tcgit help [COMMAND]
• tcgit merge [BASEBRANCH]
• tcgit refresh [BASEBRANCH]

tcgit autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ tcgit autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ tcgit autocomplete
  $ tcgit autocomplete bash
  $ tcgit autocomplete zsh
  $ tcgit autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

tcgit branch [ISSUEID]

checkout (and create) the branch with issue title

USAGE
  $ tcgit branch [ISSUEID]

ARGUMENTS
  ISSUEID  issue id

EXAMPLE
  $ tcgit branch 1
  checkout (or create and checkout) branch "issue-title-1"

See code: src/commands/branch.ts

tcgit help [COMMAND]

display help for tcgit

USAGE
  $ tcgit help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

tcgit merge [BASEBRANCH]

merge branch with main

USAGE
  $ tcgit merge [BASEBRANCH]

ARGUMENTS
  BASEBRANCH  [default: main] base branch to rebase to

EXAMPLES
  $ tcgit merge
  merge current-branch with main

  $ tcgit merge a-branch
  merge a-branch with main

See code: src/commands/merge.ts

tcgit refresh [BASEBRANCH]

rebase to fresh base branch

USAGE
  $ tcgit refresh [BASEBRANCH]

ARGUMENTS
  BASEBRANCH  [default: main] branch to rebase to

EXAMPLE
  $ tcgit refresh
  Rebase to fresh base branch

See code: src/commands/refresh.ts