run-cli

Run-cli

A run-codes cli front end with some extra features

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Run-cli is a tool to use run.codes from the command line.

What it can do:

• Login in run codes site
• Save your credentials
• Select a course and a exercise
• Show a list of upcoming exercises
• Create an initial template from your submission type selection
  • C++
  • C
  • Haskell
  • Java 8
  • Zip MakeFile
  • Python 3
• Download exercise descriptions
• Download exercise related files
• Run and compile your code
• Download all test cases
• Run your test cases locally
  • Run a specific test case
• Generate a report for the test cases output
• Send your submission to run.codes
• Show your run.codes results
• Subscribe in new courses
• Get the input of the closed test cases
• Import projects from git/run.codes

See the open issues for a full list of proposed features (and known issues).

Built With Rust

Used libraries:

• clap
• reqwest
• rpassword
• scraper
• html2md
• git2
• zip
• dialoguer
• chrono
• serde
• toml
• home
• colored
• rust-embed

Getting Started

How to get started with the project

Prerequisites

First you will need to install rust.

Installation

1. Clone the repo

    git clone https://github.com/Math-42/run-cli && cd run-cli

2. Install cargo packages and build the project

   cargo install --path .

3. Create a project

   run-cli init

Usage

Run:

run-cli -h

To get a full list of possible commands.

run-cli 0.9.1
A run.codes cli front end with some extra features.

USAGE:
    run-cli <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    build          Compile the project
    credentials    Set the user credentials
    fetch          Show the next exercises
    help           Print this message or the help of the given subcommand(s)
    import         Import a project from a git repo or from run codes
    init           Start a new project
    run            Runs the project
    secret         Get the closed test cases
    send           Submit the current project to run.codes
    subscribe      Enroll to a new class
    test           Run all test cases
    update         Update the data of the exercise
USAGE:
    run-cli <SUBCOMMAND>

How to Contribute

1. Fork the Project
2. Create your Feature Branch (git checkout -b features/feature-name)
3. Commit your Changes (git commit -m 'feature: Add some code')
4. Push to the Branch (git push origin features/feature-name)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

back to top