.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.SH "SYNOPSIS"
Remove items from a bupstash repository\.
.P
\fBbupstash rm [OPTIONS] QUERY\|\.\|\.\|\.\fR
.SH "DESCRIPTION"
\fBbupstash rm\fR removes items from a bupstash repository\.
.P
Items that are removed are not immediately deleted, instead the deletion and space reclamation is scheduled for the next time the garbage collector bupstash\-gc(1) is run\.
.P
Only the metadata needs to be decrypted to remove items, so a metadata key is sufficient for item deletion, even without access to the data decryption key\.
.SH "QUERY LANGUAGE"
For full documentation on the query language, see bupstash\-query\-language(7)\.
.SS "Remove query examples"
``` $ id=$(bupstash put \./some\-data)
.P
$ bupstash rm id=$id
.P
$ bupstash rm name=backups\.tar
.P
$ bupstash rm \-\-allow\-many name=\'*\.tar\' and older\-than 30d
.P
$ bupstash rm \-\-allow\-many id="*" ```
.SH "QUERY CACHING"
The rm command uses the same query caching mechanisms as bupstash\-list(1), check that page for more information on the query cache\.
.SH "OPTIONS"
.TP
\-r, \-\-repository REPO
The repository to connect to\. May be of the form \fBssh://$SERVER/$PATH\fR for remote repositories if ssh access is configured\. If not specified, is set to \fBBUPSTASH_REPOSITORY\fR\.
.TP
\-k, \-\-key KEY
Key used to decrypt metadata when executing a query\. If not set, defaults to \fBBUPSTASH_KEY\fR\.
.TP
\-\-query\-cache PATH
Path to the query\-cache file, defaults to one of the following, in order, provided the appropriate environment variables are set, \fB$BUPSTASH_QUERY_CACHE\fR, \fB$XDG_CACHE_HOME/\.cache/bupstash/bupstash\.qcache\fR or \fB$HOME/\.cache/bupstash/bupstash\.qcache\fR\.
.TP
\-\-query\-encrypted
The query will not decrypt any metadata, allowing you to list items you do not have a decryption key for\. This option inserts the pseudo query tag \'decryption\-key\-id\'\.
.TP
\-\-ids\-from\-stdin
Remove items with IDs read from stdin, one per line, instead of executing a query\.
.TP
\-\-allow\-many
By default bupstash refuses to remove multiple items from a single query, this flag disables that safety feature\.
.TP
\-\-utc\-timestamps
Display and search against timestamps in utc time instead of local time\.
.TP
\-\-no\-progress
Suppress progress indicators (Progress indicators are also suppressed when stderr is not an interactive terminal)\.
.TP
\-q, \-\-quiet
Be quiet, implies \-\-no\-progress\.
.SH "ENVIRONMENT"
.TP
BUPSTASH_REPOSITORY
The repository to connect to\. May be of the form \fBssh://$SERVER/$PATH\fR for remote repositories if ssh access is configured\.
.TP
BUPSTASH_REPOSITORY_COMMAND
A command to run to connect to an instance of bupstash\-serve(1)\. This allows more complex connections to the repository for less common use cases\.
.TP
BUPSTASH_KEY
Path to a primary key that will be used for decrypting data and metadata\.
.TP
BUPSTASH_KEY_COMMAND
A command to run that must print the key data, can be used instead of BUPSTASH_KEY to fetch the key from arbitrary locations such as the network or other secret storage\.
.TP
BUPSTASH_QUERY_CACHE
Path to the query cache file to use\.
.SH "EXAMPLES"
.SS "remove an item with a specific id from the repository"
\fB$ bupstash rm id=14ebd2073b258b1f55c5bbc889c49db4\fR
.SS "remove all items from the respository"
\fB$ bupstash rm id="*"\fR
.SS "remove items with name backup\.tar that are older than 30 days"
\fB$ bupstash rm name=backup\.tar and older\-than 30d\fR
.SS "remove items with a custom script"
\fB$ bupstash list \-\-format=jsonl1 \e | custom\-json\-filter \e | bupstash rm \-\-ids\-from\-stdin\fR
.SH "SEE ALSO"
bupstash(1), bupstash\-list(1), bupstash\-gc(1), bupstash\-query\-language(7)