CPH for Zed

Competitive Programming Helper for Zed - seamlessly receive problems from competitive-companion and generate solution templates with test cases.

Overview

CPH for Zed integrates with the popular competitive-companion browser extension to streamline your competitive programming workflow. Parse problems from 100+ online judges including Codeforces, AtCoder, LeetCode, and more.

Key Features

• 📋 Problem Parsing: Receive problems directly from competitive-companion
• 📝 Smart Templates: Generate solution files with language-specific templates (C++, Python, Rust, Java)
• 🧪 Test Case Management: Automatically create input/output test files
• 📁 Organized Structure: Problems are neatly organized by contest and problem name
• 🔗 Metadata Tracking: Keep track of problem URLs, time limits, and memory constraints

Supported Online Judges

Works with all websites supported by competitive-companion, including:

• Codeforces
• AtCoder
• LeetCode
• CodeChef
• HackerRank
• SPOJ
• CSES
• And 100+ more

Installation

From Zed Extensions (Recommended)

1. Open Zed
2. Open the Extensions panel (Cmd+Shift+X on macOS, Ctrl+Shift+X on Linux)
3. Search for "Competitive Programming Helper" or "CPH"
4. Click Install

As Development Extension

git clone https://github.com/ashusevim/cph-zed.git
cd cph-zed

Then in Zed: Extensions → Install Dev Extension → Select the cph-zed directory

Quick Start

Step 1: Install competitive-companion

Install the browser extension:

• Chrome Web Store
• Firefox Add-ons

Step 2: Install the companion server

cargo install cph-server

Step 3: Start the server

cph-server --port 10045 --dir ./problems

Step 4: Parse a problem

1. Navigate to any problem on Codeforces, AtCoder, etc.
2. Click the competitive-companion icon in your browser
3. Solution files appear automatically in your workspace!

Slash Commands

Use these slash commands in Zed's AI assistant panel:

Command	Description
/cph-fetch <json>	Create problem files from pasted JSON
/cph-run [n]	Show command to run test case n (or all)
/cph-test	Show command to test against all cases
/cph-server	Info about the companion server

Generated File Structure

When you parse a problem, CPH creates this structure:

problems/
└── Codeforces_-_Educational_Round_123/
    └── A_Example_Problem/
        ├── A_Example_Problem.cpp    # Solution template
        ├── problem.json             # Problem metadata
        └── tests/
            ├── 1.in                 # Sample input 1
            ├── 1.out                # Expected output 1
            ├── 2.in                 # Sample input 2
            └── 2.out                # Expected output 2

Solution Templates

C++ Template (Default)

#include <bits/stdc++.h>
using namespace std;

void solve() {
    // Your solution here
}

int main() {
    ios::sync_with_stdio(false);
    cin.tie(nullptr);
    
    int t = 1;
    // cin >> t;  // Uncomment for multiple test cases
    while (t--) solve();
    return 0;
}

Templates are also available for Python, Rust, and Java.

Server CLI Options

cph-server [OPTIONS]

Options:
  -p, --port <PORT>        Port to listen on [default: 10045]
  -d, --dir <DIR>          Directory for problem files [default: .]
  -l, --language <LANG>    Template language: cpp, python, rust, java [default: cpp]
  -n, --notify             Enable desktop notifications [default: true]
  -h, --help               Print help
  -V, --version            Print version

Requirements

• Zed editor (latest version recommended)
• competitive-companion browser extension
• Rust (for building the companion server)

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Related Projects

• competitive-companion - Browser extension for parsing problems
• cph-server - Companion HTTP server (published separately)
• CPH for VS Code - Similar extension for VS Code

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• jmerle for creating competitive-companion
• The Zed team for the excellent extension API
• The competitive programming community