Package Exports

chromium-helper
chromium-helper/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (chromium-helper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Chromium Helper CLI

A powerful command-line tool for searching and exploring Chromium and PDFium source code using Google's official APIs. Features comprehensive Gerrit integration, issue tracking, and support for both Chromium and PDFium projects.

✨ Features

🔍 Advanced Code Search - Search Chromium and PDFium codebases with powerful syntax
🔧 Complete Gerrit Integration - View CLs, comments, diffs, and file content for both projects
🐛 Issue Tracking - Search and view Chromium issues with detailed information
📊 PDFium Support - Full support for PDFium Gerrit operations and code search
🎨 Multiple Output Formats - JSON, table, and plain text formats for different use cases
⚡ Fast & Reliable - Uses official Google APIs for real-time data
🌐 Direct Links - Every result includes clickable URLs to view code online
🤖 AI-Friendly - Perfect for integration with AI systems, shell scripts, and automation

🚀 Quick Start

# Option 1: Use instantly (no installation needed!)
npx chromium-helper search "LOG(INFO)" --limit 5
npx chromium-helper gerrit status 6624568
npx chromium-helper issues search "memory leak" --limit 10

# Option 2: Install globally for short 'ch' alias
npm install -g chromium-helper

# Then use with short commands
ch search "memory leak" --case-sensitive --format json
ch gerrit status 6624568
ch pdfium status 130850

📦 Installation

Option 1: Instant Usage with npx (Recommended)

No installation required! Just run any command:

npx chromium-helper search "Browser::Create" --format json
npx chromium-helper gerrit status 6624568
npx chromium-helper issues search "security" --limit 20

Option 2: Global Installation

For faster startup and short 'ch' alias:

npm install -g chromium-helper
# Now available as 'chromium-helper' and 'ch'

Option 3: From Source

git clone https://github.com/hjanuschka/chromium-helper.git
cd chromium-helper/chromium-helper-cli
npm install && npm run build
npm link  # Optional: Make globally available

📖 Commands

`search` - Search Chromium Source Code

Search for code patterns in the Chromium codebase.

ch search <query> [options]

# Aliases: s

Options:
  -c, --case-sensitive          Case sensitive search
  -l, --language <lang>         Filter by programming language (cpp, javascript, python, etc.)
  -p, --file-pattern <pattern>  File pattern filter (*.cc, *.h, chrome/browser/*, etc.)
  -t, --type <type>             Search type: content|function|class|symbol|comment
  --exclude-comments            Exclude comments from search results
  --limit <number>              Maximum number of results (default: 20)

Examples:

# Basic text search
ch search "LOG(INFO)"

# Function search
ch search "CreateWindow" --type function

# Class search in C++ headers  
ch search "Browser" --type class --file-pattern "*.h"

# Search excluding comments
ch search "TODO" --exclude-comments

# Language-specific search
ch search "addEventListener" --language javascript

`symbol` - Find Symbol Definitions and Usage

Find where symbols (functions, classes, variables) are defined and used.

ch symbol <symbol> [options]

# Aliases: sym

Options:
  -f, --file <path>  File path context for symbol resolution

Examples:

# Find Browser symbol
ch symbol "Browser"

# Find with file context
ch symbol "CreateWindow" --file "chrome/browser/ui/browser.cc"

`file` - Get File Content

Fetch the content of any file from Chromium source.

ch file <path> [options]

# Aliases: f

Options:
  -s, --start <line>  Starting line number
  -e, --end <line>    Ending line number

Examples:

# Get entire file
ch file "base/logging.h"

# Get specific line range
ch file "chrome/browser/ui/browser.h" --start 100 --end 200

# Get from line 50 to end
ch file "content/browser/browser_context.h" --start 50

`owners` - Find OWNERS Files

Find OWNERS files for a given file path to identify code reviewers.

ch owners <path>

# Aliases: own

Examples:

# Find owners for a specific file
ch owners "chrome/browser/ui/browser.cc"

# Find owners for a directory
ch owners "third_party/blink/renderer/"

`commits` - Search Commit History

Search commit messages and metadata in the Chromium repository.

ch commits <query> [options]

# Aliases: cm

Options:
  -a, --author <author>    Filter by author name or email
  --since <date>           Commits after date (YYYY-MM-DD)
  --until <date>           Commits before date (YYYY-MM-DD)
  --limit <number>         Maximum number of results (default: 20)

Examples:

# Search commit messages
ch commits "password manager"

# Search by author
ch commits "security fix" --author "chrome-security"

# Search in date range
ch commits "memory leak" --since "2023-01-01" --until "2023-12-31"

`gerrit` - Gerrit Code Review Operations

Work with Chromium Gerrit code reviews.

ch gerrit <command> [options]

# Aliases: gr

Commands:
  status <cl>                Get CL status and test results
  comments <cl> [options]    Get CL review comments

Examples:

# Get CL status
ch gerrit status 6624568

# Get review comments
ch gerrit comments 6624568 --format json

# Get diff for specific file
ch gerrit diff 6624568 --file "base/logging.cc"

# Get file content from patchset
ch gerrit file 6624568 "base/logging.cc" --patchset 3

`pdfium` - PDFium Gerrit Operations

Work with PDFium Gerrit code reviews.

ch pdfium <command> [options]

# Aliases: pdf

Commands:
  status <cl>                Get PDFium CL status and test results
  comments <cl> [options]    Get PDFium CL review comments
  diff <cl> [options]        Get PDFium CL diff/changes
  file <cl> <path> [options] Get file content from PDFium CL patchset

Examples:

# Get PDFium CL status
ch pdfium status 130850

# Get PDFium review comments
ch pdfium comments 130850 --format json

# View PDFium file changes
ch pdfium diff 130850 --file "fpdfsdk/fpdf_view.cpp"

# Get PDFium file content
ch pdfium file 130850 "fpdfsdk/fpdf_view.cpp" --patchset 9

`issues` - Chromium Issue Operations

Search and view Chromium issues and bugs.

ch issues <command> [options]

# Aliases: bugs

Commands:
  get <id>                   Get specific issue details
  search <query> [options]   Search for issues

Examples:

# Search for issues
ch issues search "memory leak" --limit 10
ch issues search "pkasting" --start 20

# Get specific issue details
ch issues get 1493929

`issue` - Get Chromium Issue Details

Get information about Chromium bugs and feature requests.

ch issue <id>

# Aliases: bug

Examples:

# Get issue details
ch issue 422768753

# Using full URL
ch issue "https://issues.chromium.org/issues/422768753"

🎨 Output Formats

Control output format with the global --format option:

Plain Text (Default)

ch search "LOG(INFO)" --format plain

Human-readable format with colors and formatting.

JSON

ch search "LOG(INFO)" --format json

Structured JSON for programmatic processing and AI systems.

Table

ch search "LOG(INFO)" --format table

Tabular format for easy reading and comparison.

⚙️ Configuration

Environment Variables

# Set custom API key
export CHROMIUM_SEARCH_API_KEY=your_api_key_here

# Disable colors
export NO_COLOR=1

Config File

Create ~/.ch.json or .ch.json in your project:

{
  "apiKey": "your_api_key_here",
  "outputFormat": "json",
  "defaultLimit": 50
}

Configuration Commands

# Show current configuration
ch config --show

# Set API key (future feature)
ch config --set-api-key "your_key"

🤖 AI and Shell Script Integration

Perfect for AI systems and shell scripts:

#!/bin/bash

# Search for security-related code
RESULTS=$(ch search "crypto" --language cpp --format json --limit 10)

# Process results with jq
echo "$RESULTS" | jq '.[] | select(.file | contains("security")) | .url'

# Find all Browser class definitions
ch symbol "Browser" --format json | jq '.classResults[].url'

# Get file content for analysis
ch file "base/security/security_context.h" --format json | \
  jq -r '.content' | head -20

📋 Use Cases

For Developers

Code Discovery: Find examples of how to use specific APIs
Architecture Understanding: Explore class hierarchies and dependencies
Code Review: Understand context around changes
Bug Investigation: Search for related code patterns

For AI Systems

Code Analysis: Extract structured information about Chromium codebase
Documentation Generation: Gather examples and usage patterns
Refactoring Assistance: Find all usages of symbols before changes
Learning: Understand large codebase patterns and conventions

For Automation

CI/CD Integration: Validate code patterns and standards
Monitoring: Track usage of deprecated APIs
Documentation: Generate up-to-date code examples
Security Audits: Search for security-sensitive code patterns

🔍 Advanced Search Techniques

Code Search Syntax

The tool supports Google CodeSearch syntax:

# Search specific function definitions
ch search "function:CreateWindow"

# Search class definitions
ch search "class:Browser"

# Search symbols (excludes comments/strings)
ch search "symbol:WebContents"

# Case-sensitive search
ch search "case:yes LOG"

# Language and file filters
ch search "lang:cpp file:*.h virtual"

Complex Queries

# Find all virtual destructors in headers
ch search "virtual ~" --file-pattern "*.h" --language cpp

# Search for TODO comments in browser code
ch search "TODO" --type comment --file-pattern "chrome/browser/*"

# Find memory management patterns
ch search "std::unique_ptr" --language cpp --exclude-comments

🚀 Performance Tips

Use --limit to control result count for faster responses
Use --file-pattern to narrow search scope
Use --language to filter by programming language
Use --format json for faster parsing in scripts
Cache results in shell scripts to avoid repeated API calls

🛠️ Development

# Clone and setup
git clone https://github.com/hjanuschka/ch-cli.git
cd ch-cli
npm install

# Development with watch mode
npm run dev

# Build
npm run build

# Test locally
node dist/index.js --help

🤝 Contributing

Fork the repository
Create a feature branch: git checkout -b feature/new-feature
Make your changes and add tests
Commit: git commit -am 'Add new feature'
Push: git push origin feature/new-feature
Create a Pull Request

📄 License

MIT License - see LICENSE file for details.

Chromium Code Search - Official web interface
Chromium Development - Developer documentation
Gerrit Code Review - Code review system

📞 Support

GitHub Issues - Bug reports and feature requests
GitHub Discussions - Questions and community

Made with ❤️ for the Chromium developer community

chromium-helper

Package Exports

Readme

Chromium Helper CLI

✨ Features

🚀 Quick Start

📦 Installation

Option 1: Instant Usage with npx (Recommended)

Option 2: Global Installation

Option 3: From Source

📖 Commands

search - Search Chromium Source Code

symbol - Find Symbol Definitions and Usage

file - Get File Content

owners - Find OWNERS Files

commits - Search Commit History

gerrit - Gerrit Code Review Operations

pdfium - PDFium Gerrit Operations

issues - Chromium Issue Operations

issue - Get Chromium Issue Details

🎨 Output Formats

Plain Text (Default)

JSON

Table

⚙️ Configuration

Environment Variables

Config File

Configuration Commands

🤖 AI and Shell Script Integration

📋 Use Cases

For Developers

For AI Systems

For Automation

🔍 Advanced Search Techniques

Code Search Syntax

Complex Queries

🚀 Performance Tips

🛠️ Development

🤝 Contributing

📄 License

🔗 Related

📞 Support

`search` - Search Chromium Source Code

`symbol` - Find Symbol Definitions and Usage

`file` - Get File Content

`owners` - Find OWNERS Files

`commits` - Search Commit History

`gerrit` - Gerrit Code Review Operations

`pdfium` - PDFium Gerrit Operations

`issues` - Chromium Issue Operations

`issue` - Get Chromium Issue Details