From 9d801aa827e9854fe22ff7c0cb19caa38344ca2e Mon Sep 17 00:00:00 2001
From: Kremilly <contact@kremilly.com>
Date: Fri, 6 Dec 2024 16:13:27 -0300
Subject: [PATCH] docs: add transfer documentation and update navigation in
 mkdocs

---
 docs/import.md   |  1 -
 docs/transfer.md | 30 ++++++++++++++++++++++++++++++
 mkdocs.yml       |  1 +
 3 files changed, 31 insertions(+), 1 deletion(-)
 create mode 100644 docs/transfer.md

diff --git a/docs/import.md b/docs/import.md
index 2a1bbd4..c77c7b0 100644
--- a/docs/import.md
+++ b/docs/import.md
@@ -9,7 +9,6 @@ dumpsync import -f /path/to/dump.sql
 ### Command Breakdown
 
 - **dumpsync**: This is the main command to invoke the DumpSync tool.
-
 - **import**: This subcommand initiates the import process to restore the database from the specified dump file.
 
 ### Options
diff --git a/docs/transfer.md b/docs/transfer.md
new file mode 100644
index 0000000..de1c02c
--- /dev/null
+++ b/docs/transfer.md
@@ -0,0 +1,30 @@
+# DumpSync Command: Transfer
+
+To transfer a database from one server to another, you can use the following command:
+
+```bash
+dumpsync import -f /path/to/dump.sql
+```
+
+### Command Breakdown
+
+- **dumpsync**: This is the main command to invoke the DumpSync tool.
+- **transfer**: This subcommand initiates the transfer process to restore the database from the specified dump file.
+
+### Options
+
+- **-f /path/to/dump.sql**: Specifies the path to the dump file that you want to restore. Replace `/path/to/dump.sql` with the actual file path to your SQL dump file.
+
+### Example
+
+To transfer a database from a dump file located at `/backups/example_dump.sql`, you would run:
+
+```bash
+dumpsync transfer -f /backups/example_dump.sql
+```
+
+### Notes
+
+- Ensure that the dump file exists and that you have the necessary permissions to read it.
+- The transfer process will overwrite existing data in the database, so be cautious when using this command, especially if restoring to a production environment.
+- It’s recommended to back up current data before performing an import to avoid accidental data loss.
diff --git a/mkdocs.yml b/mkdocs.yml
index 09e684f..dd2b11e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -31,6 +31,7 @@ nav:
   - Settings: settings.md
   - Export: export.md
   - Import: import.md
+  - Transfer: transfer.md
 
 markdown_extensions:
   - tables