Skip to content

Commit 696b95a

Browse files
committed
docs(branches): document main-branch password field omission in get command
The main branch omits POSTGRES_URL and POSTGRES_URL_NON_POOLING because production database credentials are not retrievable via the Management API. Add a note to the Long description so the behavior is visible in both --help output and the auto-generated CLI reference docs. Fixes CLI-1450
1 parent ed13af7 commit 696b95a

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

apps/cli-go/cmd/branches.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@ var (
7878
branchGetCmd = &cobra.Command{
7979
Use: "get [name]",
8080
Short: "Retrieve details of a preview branch",
81-
Long: "Retrieve details of the specified preview branch.",
81+
Long: `Retrieve details of the specified preview branch.
82+
83+
Note: For the main branch, password-dependent fields (POSTGRES_URL, POSTGRES_URL_NON_POOLING) are not populated because production database credentials are not retrievable via API.`,
8284
Args: cobra.MaximumNArgs(1),
8385
RunE: func(cmd *cobra.Command, args []string) error {
8486
ctx := cmd.Context()

0 commit comments

Comments
 (0)