Skip to content

parisosuch-dev/cook-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cook-cli

An open source todo list for a better DX. Cook in real time. 🍳

"Let me cook"

Made with commander.js

Warning

This project is in pre-release and is not complete.

Installation

cook-cli has not been added to the npm registry yet. (soon)

$ npm install -g https://github.com/parisosuch-dev/cook-cli

You must install npm package globally in order to add the binary to your path.

Quick Guide

Get usage:

$ cook
Usage: cook [options] [command]

A todo list CLI -- nothing to do with actually cooking. It's all a metaphor.

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

Commands:
  add|a <task>      Add a task to the todo list
  list|l [options]  list all in to-do
  check|c <index>   check off an item on the to-do list
  clear             clear all items on to-do list
  help [command]    display help for command

Add a task

cook add "<task>"

List tasks

cook list
Your TODO list:
[0] 10/26/2023 this is an example task.

If you want to list tasks with the timestamp:

cook list -t

Check off a task

Using the index from the resulting list command:

cook check <index>

Clear all items on list

cook clear

Want to contribute?

Feel free to open up a PR with detailed reasoning in description or open up an issue to prompt an idea.

Releases

No releases published

Packages

No packages published