Hoot-cli
The assignment tracking system for tech-savvy students.
Usage
How to use Hoot
Installation
Hoot is available on the npm registry, so installation is a breeze:
npm i -g hoot-cli
Alternatively, you can run
npx hoot <options>
Setup
If you have hoot installed locally, you can run hoot setup, or npx hoot setup.
Structure
+----------------------------------------------+
| |
| School |
| + |
| | |
| +--+ {Subject} |
| + |
| +-> {Unit} |
| + |
| | |
| +-> Assignments |
| | + |
| | +-> {Assignment} |
| | |
| +-> Homework |
| | |
| | |
| | |
| +-> Finished |
| | |
| | |
| +-> Notes |
| |
| |
| Folder Structure |
+----------------------------------------------+
Before creating assignments, you will need to create the associated units and subjects using the hoot unit and hoot subject commands, respectively.
Subjects
Hoot runs on this folder directory:
School / Term <number> / <Subject> / <Unit> / <Assignments|Finished|Notes|Homework>
To generate a subject directory with hoot.json, run:
hoot new subject <title>
Where <title> is the name of the subject.
Use the hoot new <item> <name> command for creation of subjects, units, assignments, or notes!
Assignments
Assignment generation is done using the hoot assignment <title> command, and templating is done by copying an assignment template in the templates/ folder.