manrajgrover/hackerrank-cli

CLI for running code using HackerRank API

HackerRank-CLI

CLI for running code using HackerRank API.

Demo

Install

Run the following command

$ npm install -g hackerrank-cli

API Key

You can get your HackerRank API Key by visiting HackerRank API page.

Usage

Commands available

$ hackerrank <command>

Commands:
  run     Run code on HackerRank server
  config  Change config file

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

Command run

$ hackerrank 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:
  hackerrank run -s A.cpp -i Input00.in -o Output.txt -l 2

Command config

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

$ sudo hackerrank config <options>

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

Examples:
  sudo hackerrank config -l

Development

Run:

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

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

To lint your code, run

$ npm run lint

License

MIT © Manraj Singh

hackerrank-cli's Issues

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.

Development: Add instructions on how to setup development environment

Description

Currently, only general guidelines for contributing have been added. We need to add instructions on how to setup development environment locally to a separate document.

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.

Add Contribution Guidelines

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

Add eslintrc

Add eslint config file for code quality

Create GIF for README.

Create a Demo GIF for README.md

Add unit tests for testing commands

Integrate HackerRank Node Wrapper

Node API Wrapper can replace current API calls and all of the logic could be moved to the dependency.

Modularize code

Shift constants, helpers to separate file

Add eslint and fix linting errors

Add eslint and fix linting errors

Integrate Travis

Integrate Travis with the project with following checks:

• Code lint
• Test cases

Move constants to separate file

Currently, they live in cli.js. They need to be moved to separate file.

Allow multiple input files.

HackerRank API supports multiple input files. This could be added feature.