docs: Add docs for the prune subcommand (#37)

Document the new feature added with atuinsh/atuin#1743
atuinsh · Feb 26, 2024 · a814efb · a814efb
1 parent 0d71741
commit a814efb
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/content/docs/configuration/config.mdx b/src/content/docs/configuration/config.mdx
@@ -269,6 +269,8 @@ history_filter = [
 ]
 ```
 
+After updating that parameter, you can run [the prune command](/reference/prune/) to remove old history entries that match the new filters.
+
 ### `secrets_filter`
 Atuin version: >= 17.0
 

diff --git a/src/content/docs/reference/prune.mdx b/src/content/docs/reference/prune.mdx
@@ -0,0 +1,13 @@
+---
+title: history prune
+---
+
+# `atuin history prune`
+
+This command deletes history entries matching the [history_filter](/configuration/config/#history_filter) configuration parameter.
+
+It can be run with `--dry-run` first to list history entries that will be removed.
+
+| Argument         | Description                                                        |
+|------------------|--------------------------------------------------------------------|
+| `--dry-run`/`-n` | List matching history lines without performing the actual deletion |