https://github.com/tomhodgins/cheq
A command-line checklist app
https://github.com/tomhodgins/cheq
checklist cli gtd list task todo trello
Last synced: 5 months ago
JSON representation
A command-line checklist app
- Host: GitHub
- URL: https://github.com/tomhodgins/cheq
- Owner: tomhodgins
- License: mit
- Created: 2018-06-18T04:28:54.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-23T00:08:43.000Z (almost 8 years ago)
- Last Synced: 2025-08-09T03:10:49.576Z (10 months ago)
- Topics: checklist, cli, gtd, list, task, todo, trello
- Language: JavaScript
- Homepage:
- Size: 33.2 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cheq
**A command-line checklist app**
## About
This is a command-line checklist with a simple text-based UI for adding, listing, removing, tagging, checking and renaming checklist items.
### Installation
This software is available as a Node module from npm, as well as pre-built binaries for windows, mac, and linux available on Github in the [releases](https://github.com/tomhodgins/cheq/releases/latest) tab.
To install cheq globally with npm, enter this into your shell:
```
$ npm install -g cheq
```
## Functions
### list
```
cheq list
// example
cheq list
cheq list all
cheq list tagged work
cheq list tagged work project1
cheq list checked
cheq list unchecked
```
The `list` function displays all of your checklist items by default. You can use the special keyword `all` to display a list of all checklist items, `tagged ` to list only those checklist items that are tagged with one or more space separated tags, or `checked` or `unchecked` to display checklist items with a matching status.
### tag
```
cheq tag
// example
cheq tag 33n grocery
```
When using the `tag` function you supply the checklist item's ID along with the desired tag. Adding the same tag to a checklist item twice will remove that tag.
### add
```
cheq add
// example
cheq add New Checklist Item
```
You can use the `add` function, followed by text to create a new checklist item of the same text. Don't worry, you can change this text for any existing item using the `rename` function.
### remove
```
cheq remove
cheq remove
// example
cheq remove all
cheq remove tagged work
cheq remove tagged work project1
cheq remove checked
cheq remove unchecked
cheq remove a3
```
Using the `remove` function we can remove individual checklist items by their ID, or sets of items matching keywords `all`, `tagged` with one or more tags supplied, `checked` or `unchecked`. This action is irreversible.
### check
```
cheq check
// example
cheq check 4g
```
The `check` function changes the status of a checklist item so it shows as checked in the list. This function only accepts individual IDs.
### uncheck
```
cheq uncheck
// example
cheq uncheck 5e
```
The `uncheck` function changes the status of a checklist item so it shows as unchecked in the list. This function only accepts individual IDs.
### rename
```
cheq rename
//example
cheq rename 15 New Title
```
The `rename` function takes the ID of an existing checklist item and replaces the current title with a new title.