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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
===============================================================================
Overview
--------
'cil' allows easy command-line creation of an issue tracker. It saves each
issue locally and in plain text. Commands are given such that these issues can
be added, edited and listed easily.
===============================================================================
Quick Start
-----------
Once installed, you should be able to run 'cil':
$ cil --help
Now change directory to your current development project. To save the issues,
'cil' requires setting up, so issue the 'init' command:
$ cil init
This creates a '.cil' file and an 'issues/' directory.
Then add an issue. An editor will pop-up and you fill in the details:
$ cil add
After you've added it, you can see a representation of the issue. Now you can
list all the issues by using the 'list' command:
$ cil list
When listing the issues, they can also be filtered:
$ cil list --status=New
$ cil list --label=Type-Enhancement
$ cil list --is-open
$ cil list --label=Milestone-v0.3 --is-open
You can see what the issue name is by looking at the 'Issue' title. Imagine it
is 'cafebabe' (which by default is the time from epoch). To see your issue
again, use the 'show' command:
$ cil show cafebabe
Another reporting command is 'summary' for which all the filter options also
apply:
$ cil summary
$ cil summary --status=New
$ cil summary --label=Type-Enhancement
$ cil summary --is-open
$ cil summary --label=Milestone-v0.3 --is-open
The columns show 'Name', 'Status', 'CreatedBy' and 'Summary'.
Shucks, we've noticed we got something wrong in the issue. Let's edit it:
$ cil edit cafebabe
Save your changes and exit your editor. The issue is now saved. Try showing it
again to make sure your changed are correct.
We have just found out more about the issue so let's add a comment to it:
$ cil comment cafebabe
When you show the issue again, you'll see the comment has been added and is now
displayed.
Adding an attachment is easy:
$ cil attach cafebabe core
... added attachment 'decaf7ea' ...
$ cil show cafebabe
If someone else added the attachment and you wish to view it, you can extract
it from the issue:
$ cil extract decaf7ea --filename=mycore
Finally, because the cil issue files reside on the filesystem in flat files,
there needs to be a way to check the integrity of the issues, therefore you can
run this to do checks regarding the whole issue list:
$ cil fsck
That's it for now. As you can see, if you've played with any kind of bug/issue
tracker before, 'cil' is straightforward.
===============================================================================
|
