git-notes
Add or view notes to Git commits
TLDR
List all notes and the objects they are attached to
List all notes attached to a given object (defaults to HEAD)
Show the notes attached to a given object (defaults to HEAD)
Append a note to a specified object (opens the default text editor)
Append a note to a specified object, specifying the message
Edit an existing note (defaults to HEAD)
Copy a note from one object to another
Remove all the notes added to a specified object
SYNOPSIS
git notes add [-f] [-m
PARAMETERS
add
Add a note to the specified object. If no object is specified, use the current commit. Uses -m, -F, -c, -C to add the note message from the command line, file, commit or commit content respectively.
copy
Copy a note from
append
Append to an existing note of the object. If the object has no existing note, it is created like `add` command. Uses -m, -F, -c, -C to add the note message from the command line, file, commit or commit content respectively.
show
Show the note attached to the specified object. If no object is specified, use the current commit.
merge
Merge notes from another notes ref into the current notes ref.
commit
Create a commit to record the current notes state.
checkout
Checkout the notes from the specified notes ref.
remove
Remove the note attached to the specified object.
prune
Remove all notes that point to non-existent objects.
get-ref
Show the current notes ref.
-f
Force operation to succeed (e.g., overwrite existing notes).
-m
Take the note directly from the command line.
-F
Take the note from the file specified by
-c
Take the note from the specified commit object.
-C
Take the note's content from the specified commit object.
The Git object (commit, blob, tree, tag) to which the note applies.
The notes ref (e.g., refs/notes/commits) to operate on.
DESCRIPTION
CAVEATS
NOTES CONFIGURATION
HISTORY
SEE ALSO
git-commit(1), git-fetch(1), git-push(1), git-merge(1)