Crates.io | tally-cli |
lib.rs | tally-cli |
version | 0.1.4 |
source | src |
created_at | 2024-10-04 23:48:30.458004 |
updated_at | 2024-11-14 21:10:27.865454 |
description | A CLI for managing counters in the terminal |
homepage | |
repository | https://github.com/uhryniuk/tally |
max_upload_size | |
id | 1397246 |
size | 268,405 |
A CLI tool to manage global counters from the command line. Written in Rust with SQLite, it's capable of managing interprocess usage and ideal for iterating and templating.
If you have cargo
on your machine you can quickly get started with the following.
# Installation (requires Rust, see alternatives below)
cargo install tally-cli
# Init database
tally
This will install tally
in your PATH and after running the tally
base command, a SQLite database will be initialized for your counters.
Shown above, you can easily install tally
if you already have Rust and cargo installed on your machine.
cargo install tally-cli
Optionally, you can play around with tally in a container with the following command.
docker run --name tally --rm -it docker.io/uhryniuk/tally
This section describes detailed usage for the tally
CLI command.
tally
is designed for for managing counters across your terminal environments. After installation, you can initialize the database with.
$ tally
0
You can start interacting with your counter immediately with the following examples.
$ tally add
1
$ tally add 10
11
$ tally sub
10
Additionally, you can maintain as many counters as you'd like, and view their state with the tally list
subcommand.
$ tally maple-syrup
0
$ tally beaver
0
$ tally list
Name Count Step Template Default
tally 0 1 {} true
maple-syrup 0 1 {} false
beaver 0 1 {} false
You're able to delete a single counter with the following.
$ tally beaver delete
tally
offers options that can be updated using the tally set
subcommand. The options include
tally <name>
command is used.tally
command is called without a name.These examples demonstrate the extent in which these features could be leveraged.
$ tally set --count 50 --step 50
$ tally add
100
$ tally monkey
0
$ tally add 50
50
$ tally list
Name Count Step Template Default
tally 50 1 {} true
monkey 0 1 {} false
$ tally monkey set --default --count 200 --step 5
$ tally add
205
$ tally list
Name Count Step Template Default
tally 50 1 {} false
monkey 205 5 {} true
The templates in tally
can reference one another, making it easy to start managing complex counting states.
# '{}' is reserved to render the count.
$ tally set --count 100 --template doody-{}
$ tally cookie
0
# Use the name in '{}' to reference another counter
$ tally cookie set --count 200 --template howdy-{tally}-{}
$ tally cookie
howdy-doody-100-200
warning:
tally
will error if trying to reference a non-existent counter.
Below demonstrates some of the other features pertaining to tally
.
Print the counter value even if a template is set.
$ tally set --count 10 --template some-template-{}
$ tally --raw
10
Add or subtract from a counter without printing to stdout.
$ tally add 100 -q # '--quiet' works too
A SQLite database is maintained at ~/.tally/tally.db
, you are able to manually delete it or optionally use the tally nuke
subcommand.
$ tally list
Name Count Step Template Default
tally 50 1 {} false
sugar 123 3 {} true
$ tally nuke
Are you sure wish to nuke? (y/n): y
Database deleted successfully.
$ tally list
Name Count Step Template Default
tally 0 1 {} true
Created by uhryniuk
. Licensed under the GPL-3.0 license.