From 436e6b25d60938f118343d9c0bb6f4d6d8bcc567 Mon Sep 17 00:00:00 2001
From: aeneasr <3372410+aeneasr@users.noreply.github.com>
Date: Wed, 27 Nov 2024 12:10:39 +0100
Subject: [PATCH] docs: improve cli messages

---
 popx/cmd.go | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/popx/cmd.go b/popx/cmd.go
index 6016bf5f..f8f43e10 100644
--- a/popx/cmd.go
+++ b/popx/cmd.go
@@ -8,6 +8,8 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/ory/x/stringsx"
+
 	"github.com/gobuffalo/pop/v6"
 	"github.com/spf13/cobra"
 
@@ -98,6 +100,36 @@ func RegisterMigrateSQLDownFlags(cmd *cobra.Command) *cobra.Command {
 	return cmd
 }
 
+func NewMigrateSQLDownCmd(binaryName string, runE func(cmd *cobra.Command, args []string) error) *cobra.Command {
+	return RegisterMigrateSQLDownFlags(&cobra.Command{
+		Use:   "down [database_url]",
+		Args:  cobra.RangeArgs(0, 1),
+		Short: "Rollback the last applied SQL migrations",
+		Long: fmt.Sprintf(`This command rolls back the last applied SQL migrations for Ory %[1]s.
+
+:::warning
+
+Before running this command, create a backup of your database. This command can be destructive as it may revert changes made by previous migrations. Run this command close to the SQL instance (same VPC / same machine).
+
+:::
+
+It is recommended to review the migrations before running them. You can do this by running the command without the --yes flag:
+
+	DSN=... %[2]s migrate sql down -e`,
+			stringsx.ToUpperInitial(binaryName),
+			binaryName),
+		Example: fmt.Sprintf(`See the current migration status:
+	DSN=... %[1]s migrate sql down -e
+
+Rollback the last 10 migrations:
+	%[1]s migrate sql down $DSN --steps 10
+
+Rollback the last 10 migrations without confirmation:
+	DSN=... %[1]s migrate sql down -e --yes --steps 10`, binaryName),
+		RunE: runE,
+	})
+}
+
 func MigrateSQLDown(cmd *cobra.Command, p MigrationProvider) (err error) {
 	steps := flagx.MustGetInt(cmd, "steps")
 	if steps < 0 {
@@ -194,6 +226,28 @@ func RegisterMigrateStatusFlags(cmd *cobra.Command) *cobra.Command {
 	return cmd
 }
 
+func NewMigrateStatusCmd(binaryName string, runE func(cmd *cobra.Command, args []string) error) *cobra.Command {
+	return RegisterMigrateStatusFlags(&cobra.Command{
+		Use:   "status [database_url]",
+		Short: "Display the current migration status",
+		Long: fmt.Sprintf(`This command shows the current migration status for Ory %[1]s.
+
+You can use this command to check which migrations have been applied and which are pending.
+
+To block until all migrations are applied, use the --block flag:
+
+	DSN=... %[1]s migrate sql status -e --block`,
+			binaryName),
+		Example: fmt.Sprintf(`See the current migration status:
+	DSN=... %[1]s migrate sql status -e
+
+Block until all migrations are applied:
+	DSN=... %[1]s migrate sql status -e --block
+`, binaryName),
+		RunE: runE,
+	})
+}
+
 func MigrateStatus(cmd *cobra.Command, p MigrationProvider) (err error) {
 	conn := p.Connection(cmd.Context())
 	if conn == nil {