constructive/pgpm/cli/src/utils/display.ts at ddeae21d8fddca8b31f1f3bdca1b29078131077a · constructive-io/constructive · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
export const usageText = `
  Usage: pgpm <command> [options]

  Core Database Operations:
    add                Add database changes to plans and create SQL files
    deploy             Deploy database changes and migrations
    verify             Verify database state and migrations
    revert             Revert database changes and migrations

  Project Management:
    init               Initialize workspace or module
    extension          Manage module dependencies
    plan               Generate module deployment plans
    package            Package module for distribution
    export             Export database migrations from existing databases
    update             Update pgpm to the latest version
    cache              Manage cached templates (clean)
    upgrade            Upgrade installed pgpm modules to latest versions (alias: up)

  Database Administration:
    dump               Dump a database to a sql file
    kill               Terminate database connections and optionally drop databases
    install            Install database modules
    tag                Add tags to changes for versioning
    clear              Clear database state
    remove             Remove database changes
    analyze            Analyze database structure
    rename             Rename database changes
    admin-users        Manage admin users

  Testing:
    test-packages      Run integration tests on all workspace packages

  Migration Tools:
    migrate            Migration management subcommands
      init             Initialize migration tracking
      status           Show migration status
      list             List all changes
      deps             Show change dependencies

  Development Tools:
    docker             Manage Docker containers (start/stop/ls, --include for additional services)
    env                Manage environment variables (--supabase, --minio)
    test-packages      Run integration tests on workspace packages

  Global Options:
    -h, --help         Display this help information
    -v, --version      Display version information
    --cwd <directory>  Working directory (default: current directory)

  Individual Command Help:
    pgpm <command> --help    Display detailed help for specific command
    pgpm <command> -h        Display detailed help for specific command

  Examples:
    pgpm deploy --help       Show deploy command options
    pgpm init workspace      Initialize new workspace
    pgpm install @pgpm/base32  Install a database module
  `;