GitHub Status for VS Code

A Visual Studio Code extension that displays the current GitHub service status in the status bar and a dedicated sidebar view, so you can spot outages without leaving your editor.

Features

• Status Bar Indicator: Color-coded icon and tooltip showing overall status
• Sidebar View: GitHub Status view lists components with live status and details
• Notifications: Optional alerts when status changes (recoveries, degradations)
• Manual Refresh: Command to fetch status on-demand
• Auto-Refresh: Checks periodically (configurable)
• Relative Time: Toggle between relative and absolute timestamps

Images

Status Panel

Status Bar

Status Details

Installation

From VSIX (local)

1. Build a package:

   npx vsce package

2. In VS Code: Extensions panel → ⋯ menu → Install from VSIX… → select the generated .vsix (e.g., github-status-0.0.1.vsix).

From Source

git clone <your-fork-or-repo-url>
cd vscode-github-status
npm install
npm run compile

Launch the Extension Development Host with F5.

Usage

• The status bar (lower-left) shows overall GitHub health with an icon and color.
• Open the sidebar view via Activity Bar → “GitHub Status” to see component-level details.
• Click a component to view a modal with more info.
• Use commands from the Command Palette:
  • GitHub Status: Check Service Status — Fetch latest status
  • GitHub Status: Show Details — Focus the GitHub Status view
  • Open GitHub Status Page — Open status.github.com in browser

Status indicators

• ✓ Green (none): All systems operational
• ⚠ Yellow (minor): Minor issues
• ⛔ Red (major/critical): Major or critical incident
• ? Gray: Unknown

Extension Settings

All settings are under “GitHub Status”.

• github-status.refreshInterval (number, default: 300, min 60, max 3600)
  • Status check interval in seconds.
• github-status.enableNotifications (boolean, default: true)
  • Show notifications when GitHub status changes.
• github-status.autoExpandOnStatusChange (boolean, default: true)
  • Automatically focus/expand the view on status changes.
• github-status.showRelativeTime (boolean, default: true)
  • Display timestamps as relative time (e.g., “5 minutes ago”).

Troubleshooting

• If the status bar item is not visible, make sure the extension is enabled and the window is not in restricted mode.
• Network restrictions or proxies may block calls to the GitHub Status API.
• Use Developer: Toggle Developer Tools to check console logs from the extension host.

Scripts

Common development scripts:

npm run compile        # type-check, lint, build
npm run watch          # watch mode for development
npm run package        # production build for packaging

Packaging & Publishing

Create a VSIX:

npx vsce package

Publish to Marketplace (after creating a publisher and logging in with vsce):

npx vsce publish

Release Notes

0.0.1

• Status bar indicator with color-coded health
• Sidebar view with component details
• Manual refresh command
• Configurable auto-refresh and time display

License

MIT — see LICENSE.

Contributing

See CONTRIBUTING.md for guidelines.