Sigi

Sigi is an organizing tool.

Use sigi as extra memory. Use it to organize your tasks, groceries, or the next board games you want to play... as stacks! Shell aliases are strongly encouraged to organize your various stacks.

``` sigi 3.0.0 An organizational tool.

USAGE: sigi [FLAGS] [OPTIONS] [SUBCOMMAND]

FLAGS: -h, --help Prints help information -q, --quiet Omit any leading labels or symbols. Recommended for use in shell scripts -s, --silent Omit any output at all. -V, --version Prints version information -v, --verbose Print more information, like when an item was created. [aliases: noisy]

OPTIONS: -f, --format Use a programmatic format. Options include [csv, json, json-compact, tsv]. Not compatible with quiet/silent/verbose. -t, --stack Manage items in a specific stack [aliases: topic, about, namespace]

SUBCOMMANDS: complete Move the current item to "history" and mark as completed. [aliases: done, finish, fulfill] count Print the total number of items in the stack [aliases: size, length] delete Move the current item to "history" and mark as deleted. [aliases: pop, remove, cancel, drop] delete-all Move all items to "_history" and mark as deleted. [aliases: purge, pop-all, remove-all, cancel-all, drop-all] head List the first N items [aliases: top, first] help Prints this message or the help of the given subcommand(s) is-empty "true" if stack has zero items, "false" (and nonzero exit code) if the stack does have items [aliases: empty] list List all items [aliases: ls, snoop, show, all] move Move current item to another stack move-all Move all items to another stack next Cycle to the next item; the current item becomes last [aliases: later, cycle, bury] peek Show the first item. (This is the default behavior when no command is given) [aliases: show] pick Move items to the top of stack by their number push Create a new item [aliases: create, add, do, start, new] rot Rotate the three most-current items [aliases: rotate] swap Swap the two most-current items tail List the last N items [aliases: bottom, last] ```

The big idea

Sigi is the Chamorro word for continue. I hope it will help you to plan more, forget less, get things done, and relax. 🌴

There's a limit to human memory, and remembering things uses up willpower. 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 find that stacks, and stack-based languages like Forth and Factor are a joy to play with.

Examples

Sigi as a to-do list

Sigi can understand do (create a task) and done (complete a task).

``` $ alias todo='sigi --stack 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 "stacks". You should save these aliases in your ~/.bashrc or ~/.zshrc or whatever your shell has for configuration. Sigi accepts a --stack flag that indicates a unique list. You can have as many stacks 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 --stack watch-later'

$ watch-later add One Punch Man Creating: One Punch Man ```

``` $ alias story-ideas='sigi --stack=story-ideas'

$ story-ideas add Alien race lives backwards through time. Creating: Alien race 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. It can be used for simple, persistent, small-scale stack use-cases.

Sigi is not intending to be highly performant. While no limits are enforced, it would not handle high, concurrent throughput well. It also is not suitable for enormous amounts of data. For something beefier with stack semantics, check out Redis.

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

Please package it up for your Linux/BSD/etc distribution. And open an issue to let us know (and/or work on man pages)!

Contributing and support

Please open an issue if you see bugs or have ideas!

I'm looking for people to use the sigi wiki to share their tips, tricks, and examples.

Thanks for checking it out!