status

The status command displays information about your current pgbranch state.

Usage

pgbranch status

Output

Database: myapp_dev (localhost:5432)
Current branch: feature-auth
Total branches: 5

Output Fields

Field	Description
Database	The working database name and connection
Current branch	The currently active branch
Total branches	Number of branches in the repository

Examples

Basic Status Check

pgbranch status

Output when on a branch:

Database: myapp_dev (localhost:5432)
Current branch: main
Total branches: 3

No Current Branch

If you deleted the current branch or just initialized:

Database: myapp_dev (localhost:5432)
Current branch: (none)
Total branches: 0

Use Cases

Verify Before Operations

Check your current state before performing operations:

# Before creating a branch
pgbranch status
# Output: Current branch: main

pgbranch branch new-feature

Scripting and Automation

Use in scripts to verify pgbranch state:

#!/bin/bash
if pgbranch status | grep -q "Current branch: main"; then
  echo "On main branch, proceeding..."
  npm run migrate
else
  echo "Please switch to main branch first"
  exit 1
fi

Debugging Connection Issues

If status fails, it helps diagnose connection problems:

pgbranch status

Possible errors:

Error: could not connect to database: connection refused
Error: pgbranch not initialized in this directory

For more detailed branch information, use log:

pgbranch log

For a simple list of branches:

pgbranch branch

log - Detailed branch history
branch - List all branches
checkout - Switch branches