Advent of Code - CLI

A simple and intuitive client for creating, solving and submitting solutions to AdventOfCode .

Create, Solve, Run and Submit your Advent Of Code solutions right from your Terminal.

CLI Usage

Advent Of Code Client
Usage: advent [command] <options>

     _          _                          _        ___     __      ____               _                           ____   _       ___ 
    / \      __| | __   __   ___   _ __   | |_     / _ \   / _|    / ___|   ___     __| |   ___                   / ___| | |     |_ _|
   / _ \    / _` | \ \ / /  / _ \ | '_ \  | __|   | | | | | |_    | |      / _ \   / _` |  / _ \      _____      | |     | |      | | 
  / ___ \  | (_| |  \ V /  |  __/ | | | | | |_    | |_| | |  _|   | |___  | (_) | | (_| | |  __/     |_____|     | |___  | |___   | | 
 /_/   \_\  \__,_|   \_/    \___| |_| |_|  \__|    \___/  |_|      \____|  \___/   \__,_|  \___|                  \____| |_____| |___|
                                                                                                                                      

Options:
  -V, --version            output the version number
  -h, --help               display help for command

Commands:
  init [options] <day>     Creates Advent of Code template for the daily challange
                           with puzzle's input and statement
  submit [options] <task>  Submits to Advent of Code your solution of a
                           puzzle (first or second puzzle of a day)
  run [options] <task>     Runs your solution for a puzzle
  help [command]           display help for command

init

Usage: advent init [options] <day>

Creates Advent of Code template for the daily challange
with puzzle's input and statement

Options:
  -l, --language <lang>  the language the tasks will be solved in (its
                         extension) (default: "py")
  -h, --help             display help for command

submit

Usage: advent submit [options] <task>

Submits to Advent of Code your solution of a puzzle (first or second puzzle of a day)

Options:
  -l, --language <lang>  The language of the tasks to be run (its extension)
                         (default: "py")
  -d, --day <day>        The day to submit the output for. If not specified,
                         the day is detected from the current working directory
  -r, --run              If specified, runs the program befor submitting
                         (default: false)
  -p, --path <path>      The path to the daily challange dir (default: ".")
  -h, --help             display help for command

run

Usage: advent run [options] <task>

Runs your solution for a puzzle

Options:
  -l, --language <lang>  the language the tasks will be solved in (its
                         extension) (default: "py")
  -p, --path <path>      the path to the daily challange dir (default: ".")
  -h, --help             display help for command

Getting Started

These instructions will get you the CLI up and running on your local machine.

Prerequisites

To run the CLI and your own AOC solutions with it, make sure you have git, node, npm and your own language of choice installed and in PATH.

To check that, run in your Terminal:

git --version
node --version
npm --version
<language of choice> --version

Installing

A step by step series of examples that tell you how to get Advent of Code CLI running

Navigate to your directory of choice for the CLI

1. Clone the repo.

git clone https://github.com/dragosv99/Advent-of-Code-CLI.git

2. Install NPM dependencies of the project.

npm install

3. Create .env for the Environment Variables need for the project to run correctly.

touch .env

4. Copy and paste this to .env .

COOKIE='yourcookie'
YEAR=2020
URL=https://adventofcode.com

5. (Optional) Get your Advent of Code cookie.

• navigate in your browser of choice
• open development tools, network tab
• open adventofcode.com, login, and inspect the HTTP Request Headers
• copy Cookie header
• paste it in the .env.

Note: This step enables submit command. Your cookie will only be visible to you, locally

6. (Optional) Activate .env .

Open index.js and replace AbsolutePathToEnv string with the absolute path to your .env. To get the path you can run in the Terminal, from the root of the project:

pwd

Note: This step enables use of .env. If followed step 5, this step is necessary

7. Activate AdventOfCode CLI

In the terminal, run the following command, from the root of the project:

npm link

8. Test it works !

In the terminal, run the following command, from any directory:

advent -h

Built With

• Commander - CLI interface
• Husky - Git Hooks
• Advent Of Code - Advent of Code

Calendar of small programming puzzles for a variety of skill sets and skill levels that can be solved in any programming language you like - Advent of Code

Contributing

Feel welcomed to pick up an issue, create issues, make a suggestion or contribute in any way you feel like.

Disclaimer

This is a For Fun project, and there exists not affiliation between this project and Advent Of Code. This project was designed and built to automate user's interactions with Advent of Code and save important seconds when submitting a solution. Please do not abuse Advent Of Code with automated requests.

Authors

• Dragos Paul Vecerdea - DragosGithub

See also the list of contributors who participated in this project.

Aknwoledgements

This project would have been impossbile without the great effort put in creating AdventOfCode and making of it a great success.