aoc-cli

Build and test Clippy and format Release crates.io

Advent of Code command-line tool 🎄

Read Advent of Code puzzle descriptions, download puzzle input, submit answers and check if they are correct, all from the comfort of your terminal.

Features ⭐️

Installation options 🎅

Compile from source

```

aoc-cli relies on openssl-sys, which requires OpenSSL libraries and headers for compiling it. On Linux, you need to install a package with OpenSSL development headers such as libssl-dev or openssl-devel.

```

Homebrew

On macOS and Linux, use Homebrew:

```

brew install scarvalhojr/tap/aoc-cli

```

Windows Package Manager

On Windows 10 and 11, use the Windows Package Manager command line tool:

```

winget install aoc-cli

```

Download release artifacts

Executables for selected platforms are available in GitHub releases. Simply download and extract the file. An installer is also available for Windows.

The Linux package is statically-linked with OpenSSL and musl C library, and it should just work on most Linux distributions.

The macOS and Windows packages should automatically detect installed OpenSSL libraries. The MSVC Windows packages require the redistributable Visual C++ runtime library, whereas the MinGW packages require the Minimalist GNU for Windows runtime libraries.

Session cookie 🍪

Different Advent of Code users get different puzzle input. To download your input and submit your answer, you need an adventofcode.com session cookie. To obtain your session cookie, login to the Advent of Code website and inspect the session value of the cookie that gets stored in your browser - see instructions here.

The session cookie (a long hex string) must be provided in a single line (no line breaks) in one of the following ways (listed in order of precedence): 1. In a file specified via the --session-file command line option. 2. In an ADVENT_OF_CODE_SESSION environment variable. 3. In a file called .adventofcode.session (note the dot) in your home directory (/home/alice on Linux, C:\Users\Alice on Windows, /Users/Alice on macOS). 4. In a file called adventofcode.session (no dot) in your user's config directory (/home/alice/.config on Linux, C:\Users\Alice\AppData\Roaming on Windows, /Users/Alice/Library/Application Support on macOS).

Usage ⛄️

```

aoc help

Advent of Code command-line tool

Usage: aoc [OPTIONS] [COMMAND]

Commands: calendar Show Advent of Code calendar and stars collected [aliases: c] download Save puzzle description and input to files [aliases: d] read Read puzzle statement (the default command) [aliases: r] submit Submit puzzle answer [aliases: s] private-leaderboard Show the state of a private leaderboard [aliases: p] help Print this message or the help of the given subcommand(s)

Options: -d, --day Puzzle day [default: last unlocked day (during Advent of Code month)] -y, --year Puzzle year [default: year of current or last Advent of Code event] -s, --session-file Path to session cookie file [default: ~/.adventofcode.session] -w, --width Width at which to wrap output [default: terminal width] -o, --overwrite Overwrite files if they already exist -I, --input-only Download puzzle input only -P, --puzzle-only Download puzzle description only -i, --input-file Path where to save puzzle input [default: input] -p, --puzzle-file Path where to save puzzle description [default: puzzle.md] -q, --quiet Restrict log messages to errors only --debug Enable debug logging -h, --help Print help information -V, --version Print version information ```

```

aoc help submit

Submit puzzle answer

Usage: aoc submit [OPTIONS]

Arguments: Puzzle part [possible values: 1, 2] Puzzle answer

Options: -d, --day Puzzle day [default: last unlocked day (during Advent of Code month)] -y, --year Puzzle year [default: year of current or last Advent of Code event] -s, --session-file Path to session cookie file [default: ~/.adventofcode.session] -w, --width Width at which to wrap output [default: terminal width] -o, --overwrite Overwrite files if they already exist -I, --input-only Download puzzle input only -P, --puzzle-only Download puzzle description only -i, --input-file Path where to save puzzle input [default: input] -p, --puzzle-file Path where to save puzzle description [default: puzzle.md] -q, --quiet Restrict log messages to errors only --debug Enable debug logging -h, --help Print help information ```

Read puzzle description

Read today's puzzle (if today is an Advent of Code day) in plain text from the comfort of your terminal.

```

aoc read

[INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool

--- Day 2: Rock Paper Scissors ---

The Elves begin to set up camp on the beach. To decide whose tent gets to be closest to the snack storage, a giant [Rock Paper Scissors][1] tournament is already in progress. ... ```

Download puzzle input

Download description and input for today's puzzle and save them to files. By default the description is saved to "puzzle.md" and the input is saved to "input" in the current directory:

```

aoc download

[INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool [INFO aoc::aoc] 🎅 Saved puzzle description to 'puzzle.md' [INFO aoc::aoc] 🎅 Saved puzzle input to 'input' ```

Submit puzzle answers

Submit the answer to part 1 of today's puzzle (in this example, the answer is 999):

```

aoc submit 1 999

[INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool

That's the right answer! You are one gold star closer to saving your vacation. [[Continue to Part Two]][1]

[1] /2022/day/2#part2 ```

See your Advent of Code calendar

Check your progress in your very own calendar. You can even check past events:

```

aoc calendar --year 2015

[INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool

                    *                          25
                   >o<                         24
                  >o<<<                        23
                 >>O<<o<                       22
                >>o>O>>@<                      21
               >O<o>>@>>*<                     20
              >o>*<<<O<o>O<                    19
             >>o<@<<<o>>>o<<                   18
            >>*>o>>>*>>>O<<<<                  17
           >*<@>>>*>>O>o<o>@<<                 16
          >O>>>O<<@<<o>>>@>>>O<                15
         >>O>>*>>@<<o<<<@>>>*>O<               14
        >O<<<@>>o>O>o<<@>>O>>o>*<              13
       >>@>>O>>*<O<o<<O<*<<<*<*<<<             12
      >>*>>>*<<<O<<@>>O>>>o<<<o<<*<            11
     >*>>>*<<@>>@<<<@<<o<o<<<@<<<*<<           10
    >>o>>>*<<@<<@<<<O>O<<<@>>>O>O<<<<           9
   >>o>*<<o>>o<<<*<<@>>o<<<@>@<<<@<<<<          8
  >@>>>@<o<<<@>>*<O<<<o<<O>>>o>*<<O<o<<         7
 >o>>*>*<<@>*<<<o>*>>>@<O<<*>>>@<<*<o>o<        6
>>o<<*<<<*>*<<<*<<*<o<<*>>>*>>>o>>O>*<<<<       5 **

O>>>o<<O<<>o>o>>OO>@<@>>o<<<< 4 * @>O<<>>><o<<>>@>>><<@>o<<

@<<<@<<<@<<o>O<<>o<@>o<<<>>>>O>>O< 2 * O>>>O>>>>@<>>>@>@<<<@<>>o>>>@>>o>@>>>>O<< 1 * | | | | _ _ _ ||_ _ _ _ ```

Show private leaderboard

If you are a member of a private leaderboard, you can see how you are faring against your friends by passing the leaderboad number:

```

aoc private-leaderboard 1234

[INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool Private leaderboard of me & my friends for Advent of Code 2022.

Gold * indicates the user got both stars for that day, silver * means just the first star, and a gray dot (.) means none.

             1111111111222222
    1234567890123456789012345

1) 274 **.*.... Emery Zboncak 2) 254 ****....... Whitney Effertz 3) 134 *............ Ezra Parisian 4) 72 ............... Asha Gerlach 5) 54 *............... Frederik Robel 6) 20 *.................. Graciela Herzog 7) 0 ................... Thad Prohaska ```

Command abbreviations

Any non-ambiguous prefix of a command can be used instead of the full command name. For instance, instead of aoc read, you can type aoc r, aoc re or aoc rea. Similarly: - Instead of calendar, type c, ca, cal, etc. - Instead of download, type d, do, dow, down, etc. - Instead of private-leaderboard, type p, pr, pri etc. - Instead of submit, type s, su, sub, etc.

More examples

Download puzzle from a previous day (assumes the current year):

```

aoc download --day 1

```

Download puzzle input from a previous year and save it to a file with a given name:

```

aoc download --year 2015 --day 1 --input-only --input-file /home/user/aoc/2015/1/input

```

An attempt to download a puzzle that is still locked fails (puzzles unlock every day between 1st and 25th of December at midnight EST/UTC-5):

```

aoc download --year 2030 --day 25

[INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool [ERROR aoc] 🔔 Puzzle 25 of 2030 is still locked ```

Submit the answer to a previous year: ```

aoc s 1 999 -y 2015 -d 1

```

Specify path to session cookie file: ```

aoc download --session-file /tmp/.aoc.session

```

Contribute 🦌

Feedback and pull requests are welcome. Please see CONTRIBUTING for guidelines and ideas.

Support Advent of Code 🎁

Advent of Code is a free online Advent calendar of small programming puzzles created by Eric Wastl and maintained by volunteers. Please consider supporting their work.