.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH SJ "1" "October 2022" "sugarjar version 0.0.11" "User Commands"
.SH NAME
sj - SugarJar, a Git/GitHub helper
.SH SYNOPSIS
sj <command> [<args>] [<options>]
.SH DESCRIPTION
Command, args, and options, can appear in any order.
.SS "OPTIONS:"
.TP
\fB\-\-[no\-]fallthru\fR
Fall\-thru to git
.TP
\fB\-\-github\-cli\fR CLI
Github CLI to use ("gh" or "hub"). Note that support for "gh" is currently experimental. default: "hub"
.TP
\fB\-\-github\-host\fR HOST
The host for "hub". Note that we will set this in the local repo config so there is no need to have multiple config files for multiple github servers. Put your default one in your config file, and simply specify this option the first time you clone or touch a repo and it will be part of that repo until changed.
.TP
\fB\-\-github\-user\fR USER
Github username
.TP
\fB\-h\fR, \fB\-\-help\fR
Print this help message
.TP
\fB\-\-ignore\-dirty\fR
Tell command that check for a dirty repo to carry on anyway.
.TP
\fB\-\-ignore\-prerun\-failure\fR
Ignore preprun failure on *push commands.
.TP
\fB\-\-log\-level\fR LEVEL
Set logging level (fatal, error, warning, info, debug, trace). Default: info
.TP
\fB\-\-[no\-]use\-color\fR
Enable color. [default: true]
.HP
\fB\-\-version\fR
.SS "COMMANDS:"
.IP
amend
.IP
Amend the current commit. Alias for "git commit \fB\-\-amend\fR".
Accepts other arguments such as "\-a" or files.
.IP
amendq, qamend
.IP
Same as "amend" but without changing the message. Alias for
"git commit \fB\-\-amend\fR \fB\-\-no\-edit\fR".
.IP
bclean
.IP
If safe, delete the current branch. Unlike "git branch \fB\-d\fR",
bclean can handle squash\-merged branches. Think of it as
a smarter "git branch \fB\-d\fR".
.IP
bcleanall
.IP
Walk all branches, and try to delete them if it's safe. See
"bclean" for details.
.IP
binfo
.IP
Verbose information about the current branch.
.IP
br
.IP
Verbose branch list. An alias for "git branch \fB\-v\fR".
.IP
feature
.IP
Create a "feature" branch. It's morally equivalent to
"git checkout \fB\-b\fR" except it defaults to creating it based on
some form of 'master' instead of your current branch. In order
of preference it will be upstream/master, origin/master, master,
depending upon what remotes are available.
.IP
forcepush, fpush
.IP
The same as "smartpush", but uses "\-\-force\-with\-lease". This is
a "safer" way of doing force\-pushes and is the recommended way
to push after rebasing or amending. Never do this to shared
branches. Very convenient for keeping the branch behind a pullrequest clean.
.IP
lint
.IP
Run any linters configured in .sugarjar.yaml.
.IP
pullsuggestions, ps
.IP
Pull any suggestions *that have been committed* in the GitHub UI.
This will show the diff and prompt for confirmation before
merging. Note that a fast\-forward merge will be used.
.IP
smartclone, sclone
.IP
A smart wrapper to "git clone" that handles forking and managing
remotes for you.
It will clone a git repository using hub\-style short name
("$org/$repo"). If the org of the repository is not the same
as your github\-user then it will fork the repo for you to
your account (if not already done) and then setup your remotes
so that "origin" is your fork and "upstream" is the upstream.
.IP
smartlog, sl
.IP
Inspired by Facebook's "sl" extension to Mercurial, this command
will show you a tree of all your local branches relative to your
upstream.
.IP
smartpullrequest, smartpr, spr
.IP
A smart wrapper to "hub pull\-request" that checks if your repo
is dirty before creating the pull request.
.IP
smartpush, spush
.IP
A smart wrapper to "git push" that runs whatever is defined in
"on_push" in .sugarjar.yml, and only pushes if they succeed.
.IP
unit
.IP
Run any unitests configured in .sugarjar.yaml.
.IP
up
.IP
Rebase the current branch on upstream/master or origin/master.
.IP
upall
.IP
Same as "up", but for all branches.
.IP
version
.IP
Print the version of sugarjar, and then run 'hub version'
to show the hub and git versions.
.PP
git version 2.35.1
hub version 2.14.2