cpt

Short for competitive programming tool, cpt is an extensively configurable, feature rich, yet lightweight command line tool, to automate the mundane stuff in competitive coding (don't we hate repetitive tasks?)

Built by CP'ers, built for CP'ers!

Written in GO, the compiled executable is cross platform, standalone (no external dependencies) and minuscule in size.

Don't forget to star ⭐the project if you found it useful. 😄

Table of Contents

• Overview
• Getting Started
  • Installation
  • Usage
• Contributing
• FAQ

Overview

Started as a casual fork of xalanq/cf-tool, and with heavy inspiration from online-judge-tools/oj, this project was brought to life. The project follows the KISS principle, making the user experience as smooth as possible.

Uses cp-tools/cpt-lib as the back end to handle and process website related tasks. The back end uses browser automation with the current browser session, doing away with any account setup related hassles.

A non-exhaustive list of notable features of this project are:

• Fetch sample test cases of a problem from the website.
• Manage code templates and create new code files with ease.
• Compile, run and validate solution code against sample tests.
• Multitude of default checkers, with the ability to use your own.
• Submit solution to server, and view real time verdict status of the submission.
• List contests, submissions and other tabulated data directly on the terminal.
• Provides the ability to dynamically auto complete shell commands.
• Flexible configurations, at the global, sub-module and local directory level.
• Ability to automatically upgrade to the latest version, once installed.
• and much, much more...

This list is severely incomplete, and the best way to acquaint yourself with all the available features is by downloading and using the tool (refer instructions below). You'll fall in love with it, I promise! 😍

Getting Started

Installation

The following instructions are only for first time users. Existing users can use cpt upgrade to upgrade the tool to the latest GitHub released version.

Download the tarball corresponding to your system from the latest release page. Extract the binary file (executable) to a suitable folder registered as a system path, to run the executable from any directory.

Alternatively, you can compile the executable from source.

git clone https://github.com/cp-tools/cpt.git && cd cpt
go build -ldflags "-s -w"

You will also require checkers to test (with the command cpt test) your solution code against. A set of default testlib checkers (maintained at cp-tools/cpt-checker) can be downloaded and installed using the command cpt upgrade -mc.

Usage

⚠️ Comprehensive documentation is underway (coming soon). ⚠️

📣 Please contribute in making the wiki documentation better!

FAQ

What is the minimal setup needed to access all core features?

There are 2 configurations that need to be done, in order to use all functionalities.

• Headless browser - Run cpt config - select browser - set headless browser - follow the instructions to configure the browser data (and cookies) to use.
• Template - Run cpt config - select template - add new - follow the template generation wizard to complete setting up the template. Also, to map the template to a language on a website, run cpt <website> config - select template - set language - select the corresponding template and set the language name (on the website) that it corresponds to.

With these configurations done, all provided functionalities are usable.

How do I configure tab autocompletion?

Run the below command and follow the instructions to enable it.

cpt completion --help

Windows (powershell) users may refer to this for installation instructions.

Note that, the tab completion must be configured every time a new command is added.