public
Description: A super simple command line task list with markdown storage
Clone URL: git://github.com/andykent/fly.git
fly / README
100644 50 lines (36 sloc) 1.566 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
All About Fly
=============
 
Fly is a super simple rubygem for tracking tasks. Fly uses markdown as it's storage format meaning that tasks are human readable and totally portable.
 
The fly gem comes complete with a command line client for easy integration into your workflow. other methods of input including a web interface and textmate bundle are planned.
 
 
Currently Fly supports...
-------------------------
- new document creation
- Document title
- Tasks
- Task tagging
- Multiple contexts
- Command line viewing, filtering, adding and editing
- Time stamping
 
 
Comming soon...
---------------
- Extended Comments and notes in separate files
- Tests, tests & more tests
 
Any help or suggestions would be appreciated.
 
 
Config
------
 
Fly uses sensible defaults but if you want to modify it's behavior then it has a few optional settings.
Settings are stored in YAML format in the file '.flyconfig'.
Fly loads settings from your home directory and then the current folder.
Here is an example of the current options available...
path: "/" # a path to the file location must end with a '/'
file: stuff.markdown # the filename used for storage
default_new_context: inbox # the default context applied to new tasks that aren't targeted
default_completed_context: completed # the default context for completed tasks, when using move without a target context
 
Usage
-----
 
fly title ["A List Title"]
fly add TASK_NAME [--context CONTEXT]
fly move TASK_IDS [--context NEW_CONTEXT]
fly list [CONTEXT] [--tags TAGS]
fly count [CONTEXT] [--tags TAGS]
fly tags [CONTEXT]