From a814efba030b985942c09c215122f655f36272c0 Mon Sep 17 00:00:00 2001
From: Xavier Vello <xavier.vello@gmail.com>
Date: Mon, 26 Feb 2024 12:46:40 +0100
Subject: [PATCH] docs: Add docs for the prune subcommand (#37)

Document the new feature added with
https://github.com/atuinsh/atuin/pull/1743
---
 src/content/docs/configuration/config.mdx |  2 ++
 src/content/docs/reference/prune.mdx      | 13 +++++++++++++
 2 files changed, 15 insertions(+)
 create mode 100644 src/content/docs/reference/prune.mdx

diff --git a/src/content/docs/configuration/config.mdx b/src/content/docs/configuration/config.mdx
index 9210b7e..7deff29 100644
--- 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
new file mode 100644
index 0000000..8c76186
--- /dev/null
+++ 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 |