Claude-Relay-Meter: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Claude Relay Meter is a multilingual VSCode extension that monitors Claude Relay Service usage statistics and displays them in the VSCode status bar. The extension fetches usage data from a relay service API and provides real-time monitoring with color-coded visual feedback based on usage thresholds.

Supported Languages: Chinese (中文) and English, with full i18n support.

Development Commands

Build and Development

npm install              # Install dependencies
npm run compile          # Compile TypeScript + copy locale files to out/
                         # This command runs both tsc compilation and copy-locales script
                         # Locale files from src/locales/*.json are copied to out/locales/
npm run copy-locales     # Copy locale JSON files to out/locales/ (standalone)
npm run watch            # Watch mode for development (TypeScript only)
npm run lint             # Run ESLint on TypeScript files
npm run package          # Package extension as .vsix file

Publishing

The extension is published as a .vsix file. After making changes:

1. Update version in package.json
2. Run npm run compile to build
3. Run npm run package to create the .vsix
4. The packaged file appears in builds/ directory

Debugging

To debug the extension in VSCode:

1. Open the project in VSCode
2. Press F5 to launch a new Extension Development Host window
3. The extension will be loaded in the new window with debugging enabled
4. Set breakpoints in TypeScript files under src/
5. View debug output in the "Claude Relay Meter" output channel

Architecture

Core Components

Extension Lifecycle (src/extension.ts)

• Entry point managing activation/deactivation
• Critical initialization order (see Important Implementation Details #1):
  1. First: initializeLogging() - Must be called before any log statements
  2. Second: initializeI18n() - Required before any translation calls
• Registers commands: refreshStats, openSettings, selectLanguage, openWebDashboard, reloadClaudeConfig, and manualReloadConfig
  • openWebDashboard: Opens the web dashboard in browser at {apiUrl}/admin-next/api-stats?apiId={apiId}
  • reloadClaudeConfig: Manually reloads configuration from ~/.claude/settings.json and updates VSCode settings
  • manualReloadConfig: Triggered from tooltip button, prompts user to choose between new and current config
• Manages timer-based auto-refresh with window focus awareness
• Handles configuration changes (including language switching) and re-initialization
• Auto-initializes config from Claude Settings if VSCode settings are empty
• Configuration namespace: relayMeter.*