README
¶
lit
Lit is a lightweight issue tracker.
To install lit, install Go if it isn't already, and run:
go get github.com/ianremmler/lit/cmd/lit
Run lit help to see how to use it.
Currently, the only configuration available is the environment variable
LIT_USER which, if set, will be used instead of the current username.
Issues are stored in a single text file in Doggerel format.
Some scripts are included to enable complex queries from the command line. Using shell command substitution, the syntax looks a bit like Lisp. For example, to list the issues that are open and either assigned to user bob or have priority greater than 1:
# Note: 'lit id' returns ids of open issues
lit list $(andl $(lit id) \
$(orl $(lit with assigned bob) \
$(lit greater priority 1)))
Documentation
¶
Overview ¶
Package lit provides the core of the lightweight issue tracker.
Index ¶
- func Get(issue *dgrl.Branch, key string) (string, bool)
- func ModifyTag(issue *dgrl.Branch, tag string, doAdd bool) bool
- func Set(issue *dgrl.Branch, key, val string) bool
- func Stamp(username string) string
- type Lit
- func (l *Lit) Attach(issue *dgrl.Branch, src, username, comment string) (string, error)
- func (l *Lit) Attachments(issue *dgrl.Branch) []string
- func (l *Lit) Compare(key, val string, isLess bool) []string
- func (l *Lit) GetAttachment(issue *dgrl.Branch, filename string) (*os.File, error)
- func (l *Lit) Init() error
- func (l *Lit) Issue(id string) *dgrl.Branch
- func (l *Lit) IssueDir(issue *dgrl.Branch) string
- func (l *Lit) IssueIds() []string
- func (l *Lit) Load() error
- func (l *Lit) Match(key, val string, doesMatch bool) []string
- func (l *Lit) NewIssues(username string, num int) []*dgrl.Branch
- func (l *Lit) Sort(ids []string, key string, doAscend bool)
- func (l *Lit) Store() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Get ¶
Get returns the value for the given key, if found in the issue. key may be a substring matching the beginning of the issue key.
Types ¶
type Lit ¶
type Lit struct {
// contains filtered or unexported fields
}
Lit stores and manipulates issues
func (*Lit) Attachments ¶
Attachments returns a list of an issue's attachments
func (*Lit) Compare ¶
Compare returns a list of ids for all issues whose value for key is less or greater, determined by isLess, than val.
func (*Lit) GetAttachment ¶
GetAttachment returns a file attached to an issue
Source Files
Directories