| OSTREE REFS(1) | ostree refs | OSTREE REFS(1) |
.SH "NAME" ostree-refs - List refs
.SH "SYNOPSIS"
.HP 288u
ostree refs [OPTIONS...] [PREFIX]
.HP 288u
ostree refs {EXISTING} {--create=NEWREF}
.SH "DESCRIPTION"
.PP Lists all refs available on the host. If specified, PREFIX assigns the
refspec prefix; default prefix is null, which lists all refs. This command
can also be used to create or delete refs.
.SH "OPTIONS"
.PP --list
For historical reasons, refs without this option will strip the specified
prefix from the output. Normally, one wants to see the full ref, so
providing this option ensures the refs are printed in full, rather than
truncated.
.RE
.PP --create=NEWREF
Create a ref pointing to the commit EXISTING. NEWREF must not already exist,
and EXISTING must be an existing commit. More than one ref can point to the
same commit.
.RE
.PP --delete
Delete refs which match PREFIX, rather than listing them. If you are trying
to reclaim space, you will then need to ostree prune or ostree
admin cleanup.
.RE
.PP --revision, -r
When listing refs, also print their revisions. The revisions will be
separated by a tab character.
.RE
.PP --alias, -A
If used with --create, create an alias. Otherwise just list
aliases.
.RE
.PP --collections, -c
Enable interactions with refs using the combination of their collection IDs
and ref names. When listing refs, this changes the output format to include
collection IDs, and enables listing remote mirrored refs.
When creating refs, the refspec value passed to the --create option is
treated as COLLECTION-ID:REF-NAME and a mirrored ref is created. (This is an
abuse of the refspec syntax.)
When deleting refs, all refs whose collection ID equals PREFIX are
deleted.
.RE
.PP --force
When creating NEWREF with --create, allow an existing ref to be
updated instead of erroring.
.RE
.SH "EXAMPLE"
.PP $ ostree refs
my-branch
gnome-ostree/buildmain/x86_64-runtime
| OSTree |