Skip to main content

signaloid-cli github status

Display current GitHub integration status.

Synopsis​

signaloid-cli github status [options]

Description​

Displays the current GitHub integration status for your Signaloid account or a specified user. This shows whether GitHub is connected and provides integration details.

Options​

OptionDescription
--user-id <id>User ID to check (defaults to current user)

Output​

Returns a JSON object with GitHub integration details:

{
  "UserID": "user-abc123",
  "GithubUsername": "myusername",
  "Connected": true,
  "ConnectedAt": "2025-01-15T10:30:00Z",
  "LastUsed": "2025-01-20T14:45:00Z",
  "Scopes": ["repo", "read:org"]
}

Examples​

Check Your GitHub Status​

signaloid-cli github status

Check Another User's Status​

# Requires appropriate permissions
signaloid-cli github status --user-id user-xyz789

Extract Specific Information​

# Check if GitHub is connected
signaloid-cli github status | jq -r '.Connected'

# Get GitHub username
signaloid-cli github status | jq -r '.GithubUsername'

# Get connection date
signaloid-cli github status | jq -r '.ConnectedAt'

# List token scopes
signaloid-cli github status | jq '.Scopes'

Verify Connection​

#!/bin/bash

STATUS=$(signaloid-cli github status 2>/dev/null)

if [ $? -eq 0 ]; then
  IS_CONNECTED=$(echo $STATUS | jq -r '.Connected')

  if [ "$IS_CONNECTED" = "true" ]; then
    USERNAME=$(echo $STATUS | jq -r '.GithubUsername')
    echo "GitHub connected as: $USERNAME"
  else
    echo "GitHub not connected"
    exit 1
  fi
else
  echo "Failed to check GitHub status"
  exit 1
fi

Monitor Integration Health​

#!/bin/bash
# Check if GitHub integration needs renewal

STATUS=$(signaloid-cli github status)
LAST_USED=$(echo $STATUS | jq -r '.LastUsed')

if [ -n "$LAST_USED" ]; then
  LAST_USED_TS=$(date -d "$LAST_USED" +%s)
  NOW_TS=$(date +%s)
  DAYS_SINCE=$((($NOW_TS - $LAST_USED_TS) / 86400))

  if [ $DAYS_SINCE -gt 90 ]; then
    echo "Warning: GitHub integration last used $DAYS_SINCE days ago"
    echo "Consider verifying token validity"
  fi
fi

Format Status Report​

# Create readable status report
signaloid-cli github status | jq -r '
  "GitHub Integration Status\n" +
  "========================\n" +
  "Username: \(.GithubUsername)\n" +
  "Connected: \(.Connected)\n" +
  "Connected At: \(.ConnectedAt)\n" +
  "Last Used: \(.LastUsed)\n" +
  "Scopes: \(.Scopes | join(", "))"
'

Exit Codes​

CodeDescription
0Success
1Failed to fetch integration status (authentication error, user not found)

Notes​

  • If GitHub is not connected, the response may indicate disconnected status
  • The --user-id option requires admin permissions for other users
  • Token scopes shown are those granted to the Personal Access Token

See Also​

Last updated on