# Sigi
Sigi is a stack-based organizing tool.
It's primarily intended for you to use as extra memory. Use it to organize your
tasks, groceries, or the next board games you want to play.
Sigi is also a stack-management tool. It can be used as disk-persistent stack
memory, for example, in a shell script or in Rust code. (And more languages in
the future!)
# Examples
## Sigi as a to-do list
Sigi can understand `do` (create a task) and `done` (complete a task).
```
$ alias todo='sigi --topic todo'
$ todo do Write some code
Creating: Write some code
$ todo do Get a drink
Creating: Get a drink
$ todo do Take a nap
Creating: Take a nap
$ todo list
Now: Take a nap
1: Get a drink
2: Write some code
$ sleep 20m
$ todo done
Completed: Take a nap
```
It's best to use sigi behind a few aliases with unique "topics". You should
save these aliases in your `~/.bashrc` or `~/.zshrc` or whatever your shell has
for configuration. Sigi accepts a `--topic` flag that indicates a unique list.
You can have as many topics as you can think of names.
Forgot what to do next?
```
$ todo
Now: Get a drink
```
Not going to do it?
```
$ todo delete
Deleted: Get a drink
```
## Sigi as a save-anything list
Extending the alias idea, you can use sigi to store anything you want to
remember later.
```
$ alias watch-later='sigi --topic watch-later'
$ watch-later add One Punch Man
Creating: One Punch Man
```
```
$ alias story-ideas='sigi --topic=story-ideas'
$ story-ideas add Alien race that lives backwards through time.
Creating: Alien race that lives backwards through time.
```
## Sigi as a local stack-based database
Sigi understands the programmer-familiar `push` (create an item) and `pop`
(remove an item and return it) idioms.
Using the `--quiet` (or `-q`) flag is recommended for shell scripts, as it
leaves out any leading labels or symbols.
TODO: Need an example, maybe a reverse polish notation calculator in bash?
# Installing
## Command-line interface (CLI)
Currently the best way to install sigi is through the Rust language package
manager, cargo:
```
cargo install sigi
```
Instructions on installing cargo can be found here:
- https://doc.rust-lang.org/cargo/getting-started/installation.html
In the future I plan to distribute sigi through more package managers.
# Library
Sigi is available as a Rust library via [crates.io](https://crates.io/crates/sigi).
It is still in active, unstable development, so I suggest not doing anything
ambitious until stable versions (i.e. >= 1.0) become available.
In the future I plan to provide wrappers through other languages. Also, the
implementation language is possibly subject to change.
# Motivation
_Sigi_ is the [Chamorro](https://en.wikipedia.org/wiki/Chamorro_language) word
for _continue_. I hope it will help you to plan more, forget less, get things
done, and relax. 🌴
There's [a limit](https://wiki.c2.com/?SevenPlusOrMinusTwo) to human memory, and
remembering things uses up [willpower](https://www.penguinrandomhouse.com/books/307740/willpower-by-roy-f-baumeister-and-john-tierney/).
I like working at a command line, and wanted a tool to free me up from trying to
juggle tasks and ideas. I also just like stacks, and stack-based languages like
[Forth](https://en.wikipedia.org/wiki/Forth_(programming_language)) and
[Factor](https://factorcode.org) are such a joy to play with.