Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakzo/aoc
Advent of Code CLI for reading, running and submitting.
https://github.com/jakzo/aoc
advent-of-code
Last synced: about 18 hours ago
JSON representation
Advent of Code CLI for reading, running and submitting.
- Host: GitHub
- URL: https://github.com/jakzo/aoc
- Owner: jakzo
- Created: 2020-12-04T01:24:17.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-20T13:07:14.000Z (almost 2 years ago)
- Last Synced: 2024-10-06T12:17:59.047Z (about 1 month ago)
- Topics: advent-of-code
- Language: TypeScript
- Homepage:
- Size: 1.9 MB
- Stars: 38
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Advent of Code CLI
Full Advent of Code dev loop in a CLI which:
- Prints challenge description in the terminal
- Downloads input to a file
- Creates a source file for your favourite language and runs it on change
- Submits answers
## Recommended Usage
Install from [binary below](#Installation) or (preferably) with Node like so:
```sh
npm i -g @jakzo/aoc
```
A few minutes before the challenge starts, open two terminals and run these commands:
```sh
# Terminal 1
aoc
# Terminal 2
aoc start js
```
This will prompt you for your session token if you haven't provided it before and save it in your operating system's credential manager.
From here the first terminal will:
- Count down until the challenge starts
- Print the description in the terminal once the challenge starts
- Download the input to a local file called `input.txt`
- Prompt for an answer to submit
- When a correct answer is submitted, repeats these steps for part 2
And the second terminal will:
- Create a new source file for your chosen language (JavaScript in the example)
- Run the created source file and rerun when any changes are saved
## Installation
If you have [Node.js](https://nodejs.org/) installed the easiest way is with:
```sh
npm i -g @jakzo/aoc
```
Or if you prefer you can install the binary for your platform:
### Linux
1. Download `aoc-linux-x64` from the [releases](https://github.com/jakzo/aoc/releases) page
1. `chmod +x aoc-linux-x64`
1. `mv aoc-linux-x64 /usr/local/bin/aoc`
### MacOS
1. Download `aoc-macos-x64` from the [releases](https://github.com/jakzo/aoc/releases) page
1. Give execute permission: `chmod +x aoc-macos-x64 && xattr -d com.apple.quarantine aoc-macos-x64`
1. Add to path: `mv aoc-macos-x64 /usr/local/bin/aoc`
### Windows
1. Download `aoc-win-x64.exe` from the [releases](https://github.com/jakzo/aoc/releases) page
1. Open Command Prompt as administrator then run:
1. `mkdir aoc` (feel free to swap `aoc` for any directory you want to install it to)
1. `move aoc-win-x64.exe aoc\aoc.exe`
1. Add to path: `cd aoc && setx /M PATH "%PATH%;%CD%"`
## Language Templates
See [./templates](./templates) for a list of possible languages. Each folder name is a valid argument you can provide to `aoc start`.
You can also create local templates so you can use languages not built-in to this tool. To do this:
1. Create a folder containing your template files
1. Make sure the source file(s) contain `wip` (case-insensitive) in their filename
- This is how the tool determines which files to save after a successful submission
1. Create an `aoc.json` file in this directory to specify commands
- These commands will be rerun on changes
- Use `{{TEMP_DIR}}` to insert the path of a temporary directory for saving build output
- Example `aoc.json` which compiles and runs the code in `wip.c`:
```json
{
"commands": ["clang -o '{{TEMP_DIR}}/wip' wip.c", "'{{TEMP_DIR}}/wip'"]
}
```
1. Use your local template by passing in the path to your template folder instead of the language name
- Example: `aoc start ./my-template-folder`
## Individual Commands
The tool also exposes individual commands in case you want to compose some functionality together with another tool. For example you can save the input for a challenge to another file with `aoc input --year 2016 --day 5 > another-file.txt`.
Documentation for individual commands can be found by running `aoc --help`:
```
$ aoc --help
Commands:
aoc Counts down, saves input, prints
description and prompts for
answers to the upcoming challenge
[default]
aoc start [language] Creates and run files from a
template for a language (does not
overwrite)
aoc login Prompts for a new session token
aoc template Copies a template folder (does
not overwrite)
aoc countdown Counts down until the next
challenge starts then exits
aoc description Prints the description of a
challenge
aoc input Prints the input to a challenge
aoc submit [answer] Submits an answer to a challenge
aoc leaderboard Outputs a CSV of times to
completion for a private
leaderboard
Options:
-y, --year The year of the challenge [number]
-d, --day The day of the challenge [number]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
```
Individual commands can also be accessed from the npm module like:
```js
const { printDescription } = require("@jakzo/aoc");
printDescription(2020, 5);
```