Categorygithub.com/alexrefshauge/advent-of-code-cli
modulepackage
0.0.0-20241205115709-12dbd995d53a
Repository: https://github.com/alexrefshauge/advent-of-code-cli.git
Documentation: pkg.go.dev

# README

advent-of-code-cli

Installation

Using the go toolchain

To install the CLI run: go install github.com/alexrefshauge/advent-of-code-cli

Since it can become tedious to write advent-of-code-cli everytime, it is recommended to register an alias for the tool i.e. aoc

Now run advent-of-code-cli in the terminal, this will also create a configuration file located at $HOME/.aoc/config.yaml

Configuration

A configuration file config.yaml is plaed in your home directory in a .aoc directory.

To enable the tool to fetch puzzle inputs automatically, please configure the sessionCookie setting. This is the cookie stored in the browser, if you are logged in to the Advent of Code website.

Example configuration file

sessionCookie: <sessionCookie>
solutiondirectory: /home/john/advent-of-code
year: 2024
day: 1

Usage

To create a new solution for the current day: advent-of-code-cli new --today Use the --today flag, to ensure that the current day is used, if you have not configured day and year.

Using the tests

To run the generated tests, you must first populate the test input files called example1.txt and example2.txt. These should contain the example input, often included in the puzzle description, followed by the solution prefixed by a :. Example:

7 6 4 2 1
1 2 7 8 9
9 7 6 2 1
1 3 2 4 5
8 6 4 4 1
1 3 6 7 9
:2

# Packages

Copyright © 2024 NAME HERE <EMAIL ADDRESS> */.
No description provided by the author
No description provided by the author