manrajgrover/hackerearth-cli

CLI for compiling and running code on HackerEarth

HackerEath-CLI

CLI for compiling and running code using HackerEarth API.

Demo

Install

Run the following command

$ npm install -g hackerearth-cli

API Key

You can get your HackerEarth API Key by visiting HackerEath API page.

Usage

Commands available

$ hackerearth <command>

Commands:
  run      Run code on HackerEarth server
  compile  Compile code on HackerEarth server
  config   Change config file

Options:
  -h, --help  Show help                                      [boolean]

Command run

$ hackerearth run <options>

Options:
  -h, --help      Show help                                  [boolean]
  -s, --source    Source Code file path                     [required]
  -i, --input     Input file path                           [required]
  -l, --language  Language. Change `config` for default.
  -o, --output    Output file path                          [required]

Examples:
  hackerearth run -s A.cpp -i Input00.in -o Output.txt -l CPP11

Command compile

$ hackerearth compile <options>

Options:
  -h, --help      Show help                                  [boolean]
  -s, --source    Source Code file path                     [required]
  -l, --language  Language. Change `config` for default.

Examples:
  hackerearth compile -s A.cpp -l CPP11

Command config

Run $ sudo hackerearth config to change configuration of your installation. This includes default language and API Key.

$ sudo hackerearth config [options]

Options:
  -h, --help  Show help                                      [boolean]
  -l, --list  List language and their code                   [boolean]

Examples:
  sudo hackerearth config -l

Development

Run:

$ git clone https://github.com/manrajgrover/HackerEarth-CLI.git
$ cd HackerEarth-CLI
$ npm link

This will setup a symbolic link to the CLI. Any changes in source files will now be reflected when running the hackerearth command.

To lint your code, run

$ npm run lint

License

MIT © Manraj Singh

hackerearth-cli's Issues

Add Contribution Guidelines

Contribution guidelines explaining how to open issues, pull requests etc needs to be added.

Demos: Move demo gifs to svg based demos

Description

Currently, we make use of gif demos, which is cool, but not as cool as svg-term-cli. Need to explore and move demos to svg based terminal sessions to improve documentation.

Migrate to HackerEarth v3 API

Description

Looks like HackerEarth v2 API has stopped working as expected and there is a need to move to v3.

Versions

• NodeJS version (if applicable): NA
• HackerEarth CLI version: NA

Error

API response is not matching the expected response.

Expected behaviour

NA

Steps to recreate

NA

People to notify

NA

Move hard coded strings to separate file

Move hard coded strings to separate file

Add unit tests

Add unit tests to the project

Modularize code with separate constant files etc

• Modularize code
• Move constants to separate file

Development: Add instructions on how to setup development environment

Description

We need to add instructions on how to setup development environment locally to a separate document.

API is broken on HackerEarth side

Description

Looks like HackerEarth's API is broken for quite a while now. If the problem persists, there would be a need to get in touch with them and make further decisions.

Versions

• NodeJS version (if applicable): NA
• HackerEarth CLI version: NA

Error

NA

Expected behaviour

NA

Steps to recreate

NA

People to notify

NA

Integrate Travis

Integrate Travis with the project with following checks:

• Code lint
• Test cases

Fix linting issues

Fix linting issues in Travis Builds

Add Issue and Pull Request Template

Need to decide on basic issue and pull request template on high priority for easy management of the same.

Create GIF for README.

Create a demo GIF for README.md.