Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jinxedbuffer/cfkit

cfkit - Codeforces CLI written in NodeJS.
https://github.com/jinxedbuffer/cfkit

cli codeforces competitive-programming nodejs online-judge shell terminal

Last synced: 16 days ago
JSON representation

cfkit - Codeforces CLI written in NodeJS.

Host: GitHub
URL: https://github.com/jinxedbuffer/cfkit
Owner: jinxedbuffer
License: mit
Created: 2024-12-31T13:19:14.000Z (25 days ago)
Default Branch: main
Last Pushed: 2025-01-08T16:57:19.000Z (17 days ago)
Last Synced: 2025-01-08T17:55:22.763Z (17 days ago)
Topics: cli, codeforces, competitive-programming, nodejs, online-judge, shell, terminal
Language: JavaScript
Homepage:
Size: 312 KB
Stars: 16
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# cfkit

[![NPM Version](https://img.shields.io/npm/v/@jinxedbuffer/cfkit.svg?style=flat)](https://www.npmjs.com/package/@jinxedbuffer/cfkit)
![NPM Downloads](https://img.shields.io/npm/dw/%40jinxedbuffer%2Fcfkit)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/jinxedbuffer/cfkit)](https://github.com/jinxedbuffer/cfkit)

cfkit is a CLI tool for competitive programming leveraging Codeforces API.

**Terminals tested on**: kitty, Konsole

**Fun fact**: I made this software so I can find random problems to solve everyday because I suck at competitive
programming and want to get better at it.

```text
_____ ______ _ _______ _______
/ ____| ____| | / /_ _|__ __|
| | | |__ | ' / | | | |
| | | __| | < | | | |
| |____| | | . \ _| |_ | |
\_____|_| |_|\_\_____| |_|

⭐ If you enjoy this software, give it a star:
https://github.com/jinxedbuffer/cfkit
```

## Table of Contents

- [Installation](#installation)
- [Upgrading](#upgrading)
- [Usage](#usage)
- [Uninstallation](#uninstallation)
- [Contributing](#contributing)
- [License](#license)

## Installation

Before proceeding to install, make sure you have **Node (v22.12.0+)** and **nvm (v0.40.1+)** installed. If they're not
installed, [install it from here](https://nodejs.org/en/download).

```shell
# Install cfkit globally
npm i -g @jinxedbuffer/cfkit

# Confirm installation
cf -v # Should print the version number
```

## Upgrading

To upgrade `cfkit` to the latest version, run:

```shell
cf upgrade
```

## Usage

Once installed, you can use the `cf` command in your terminal. Here's an overview of how to use the available commands:

### Help

_To see the available commands, run:_

```shell
cf -h
```

This will display a list of commands and their descriptions.

### Contests

_Use the `contest` or `c` command to view available contests._

```shell
cf contest|c [options]
```

**Options**

| Option | Description |
|:---------------------:|:---------------------------------------------------------|
| `-i, --id ` | Show details of a contest by its ID. |
| `-s, --search ` | Search for a contest by its name. |
| `-u, --upcoming` | Show upcoming contests. |
| `-a, --active` | Show active contests. |
| `-l, --limit ` | Limit the number of contests to show (default is `100`). |
| `-g, --gym` | Show only gym contests. |

**Example**

- _Show details of a contest by ID:_

```text
$ cf contest -i 1780

┌──────────────────────────────────────────────────────────┐
│ Contest # 1780 │
├─────────────────┬────────────────────────────────────────┤
│ Name │ Codeforces Round 846 (Div. 2) │
├─────────────────┼────────────────────────────────────────┤
│ Phase │ FINISHED │
├─────────────────┼────────────────────────────────────────┤
│ Frozen │ No │
├─────────────────┼────────────────────────────────────────┤
│ Duration │ 2 hours │
├─────────────────┼────────────────────────────────────────┤
│ Start Time │ 25 Jan 2023 | 08:05 PM (2 years ago) │
├─────────────────┼────────────────────────────────────────┤
│ Link │ https://codeforces.com/contest/1780 │
└─────────────────┴────────────────────────────────────────┘
? Choose an option (Use arrow keys)
❯ Open in browser
Generate files for this contest
See problems
Back
Exit
```

- _Show upcoming contests:_

```text
$ cf contest -u

? Select a contest (Use arrow keys)
❯ # 2056 │ in 13 days │ Codeforces Round (Div. 2)
# 2055 │ in 8 days │ Codeforces Round (Div. 2)
# 2057 │ in 3 hours │ Hello 2025
```

- _Search for a contest by name:_

```text
$ cf contest -s "round 993"

? Select a contest (Use arrow keys)
❯ # 2044 │ 20 days ago │ Codeforces Round 993 (Div. 4)
```

### Problems

_Use the `problem` or `p` command to view problems from the problem set._

```shell
cf problem|p [options]
```

**Options**

| Option | Description |
|:-----------------------:|:--------------------------------------------------------|
| `-R, --randomize` | Randomize the list of problems. |
| `-i, --id ` | Search for a problem by its ID. |
| `-s, --search ` | Search for a problem by its name. |
| `-c, --contest ` | Show problems from a specific contest. |
| `-l, --limit ` | Limit the number of problems to show (default is `15`). |
| `-r, --rating ` | Set a rating filter. |
| `-t, --tags ` | Set tags filter (comma-separated tags). |

**Example**

- _Show 10 problems with rating equal to 1500:_

```text
$ cf problem -r 1500 -l 10

? Select a problem
❯ # 2050E │ Three Strings │ dp, implementation, strings
# 2049C │ MEX Cycle │ brute force, constructive algorithms, greedy, implementation
# 2027C │ Add Zeros │ brute force, data structures, dfs and similar, dp, graphs, greedy
# 2026C │ Action Figures │ binary search, brute force, constructive algorithms, data structures,
# 2008E │ Alternating String │ brute force, data structures, dp, greedy, implementation, strings
# 2007C │ Dora and C++ │ math, number theory
# 2003D1 │ Turtle and a MEX Problem (Easy Version) │ greedy, math
(Use arrow keys to reveal more choices)
```

- _Search for problems by name:_

```text
$ cf problem -s "queen"

? Select a problem (Use arrow keys)
❯ # 1667C │ Half Queen Cover │ constructive algorithms, math
# 1143C │ Queen │ dfs and similar, trees
# 685E │ Travelling Through the Snow Queen's Kingdom │ bitmasks, brute force, divide and conquer, graphs
# 587E │ Duff as a Queen │ data structures
# 131E │ Yet Another Task with Queens │ sortings
```

- _Search for problems by tags:_

```text
$ cf problem -t "tree"

? Select a problem
❯ # 2053E │ Resourceful Caterpillar Sequence │ dfs and similar, dp, games, graphs, greedy, trees
# 2052M │ Managing Cluster │ dp, graphs, math, trees
# 2050G │ Tree Destruction │ dfs and similar, dp, trees
# 2048F │ Kevin and Math Class │ brute force, data structures, divide and conquer, dp, implementation, math
# 2044G2 │ Medium Demon Problem (hard version) │ dfs and similar, dp, dsu, graphs, implementation, trees
# 2044G1 │ Medium Demon Problem (easy version) │ dfs and similar, graph matchings, graphs, implementation, trees
# 2042E │ Vertex Pairs │ binary search, brute force, data structures, dfs and similar, divide and c
(Use arrow keys to reveal more choices)

```

### Generate

_Use the `generate` or `g` command to generate input, output, and code files._

```shell
cf generate|g [options]
```

This will generate `in.txt`, `out.txt`, and `main.cpp` files in your **current working directory**.

| Option | Description |
|:-----------------------:|:------------------------------------------------------------|
| `-c, --contest ` | Generates files for each problem in contest. |
| `-p, --problem ` | Generate files for a problem |
| `-t, --template ` | Placeholder to use for `main.cpp` (default: `template.cpp`) |

**Example**

- _Generate files for problem ID `2047B`_

```text
$ cf generate -p 2047B

✔ Successfully generated files for problem # 2047B
````

This will create files for problem ID `2047B` in a folder named `2047B` in the current working directory.

- _Generate files for all problems of contest ID `2047`_

```text
$ cf generate -c 2047

✔ Successfully generated files for problem # 2047A
✔ Successfully generated files for problem # 2047B
✔ Successfully generated files for problem # 2047C
✔ Successfully generated files for problem # 2047D
✔ Successfully generated files for problem # 2047E
✔ Successfully generated files for problem # 2047F
```

This will create folders and files for each problem in contest ID `2047` (e.g., `2047A`, `2047B`, ...) in the current
working directory.

```text
./
├── 2047A/
│ ├── in.txt
│ ├── main.cpp
│ └── out.txt
├── 2047B/
│ ├── in.txt
│ ├── main.cpp
│ └── out.txt
├── 2047C/
│ ├── in.txt
│ ├── main.cpp
│ └── out.txt
.
.
```

**Note:** If both options are omitted, only blank files will be created. Use `-p` or `-c` to parse testcases as well.

### Judge

_Use the `judge` or `j` command to judge code against test cases._

**Note: Currently only C++ is supported.**

```shell
cf judge|j [options]
```

**Options:**

**Example**

- _Judge `main.cpp` against testcase files (`in.txt` and `out.txt`)_

```text
$ cf judge

✔ Compilation successful
✔ Execution for testcase 1 successful (took 5.10 ms)
Testcase 1: [x] Failed
┌──────────┬─────┐
│ Expected │ Got │
├──────────┼─────┤
│ a │ 1 │
│ b │ 2 │
│ d │ 3 │
└──────────┴─────┘
```

- **Note:** If no options are provided, make sure to keep all three files are in the same directory and `cf judge` is
executed in the same folder.

### Blogs

_Use the `blog` or `b` command to view blogs._

```shell
cf blog|b [options]
```

**Options:**

| Option | Description |
|:--------------------------------:|:------------------------|
| `-u, --user ` (required) | Show blog posts by user |

**Example:**

- _Show blogs of an user:_

```text
$ cf blog -u MikeMirzayanov

? Choose a blog
❯ # 137946 │ 6 days ago │ New Year's Eve Update: Random Problems for Mashups
# 137533 │ 9 days ago │ MaraTON Challenge 1
# 137562 │ 14 days ago │ Goodbye, 2024. Hello, 2025!
# 134010 │ 4 months ago │ ICPC World Finals in Astana: I invite you to a push-up challenge!
# 133941 │ 4 months ago │ Rule Restricting the Use of AI [revision 2024-09-14]
# 133401 │ 4 months ago │ Congratulations: Tourist has reached a rating of 4000!
# 133293 │ 4 months ago │ Testing Round 19 [unrated registration testing]
(Use arrow keys to reveal more choices)
```

### Cache

_To delete all stored cache, use the `flush` pr `f` command:_

```shell
cf flush|f
```

This will clear the cache data from your system.

## Uninstallation

To uninstall `cfkit`, run this command:

```shell
npm uninstall -g @jinxedbuffer/cfkit
```

## Contributing

Contributions are welcome! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Make your changes.
4. Commit your changes (`git commit -m "Add feature/bugfix"`).
5. Push your branch to your forked repository (`git push origin feature/your-feature-name`).
6. Open a pull request with a description of your changes.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.