-
Notifications
You must be signed in to change notification settings - Fork 4
/
sigi.1
172 lines (172 loc) · 4.19 KB
/
sigi.1
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
.TH sigi 1 "May 29, 2024" "version 3.7.1" "USER COMMANDS"
.\"
.SH NAME
sigi \- An organizing tool for terminal lovers who hate organizing
.\"
.SH SYNOPSIS
.B sigi
[FLAGS] [OPTIONS] [SUBCOMMAND]
.\"
.\" ================================
.\"
.SH DESCRIPTION
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.
.PP
.I Sigi
is the Chamorro word for
.I continue.
I hope this will help you to plan more, forget less, get things done, and relax.
.\"
.\" ================================
.\"
.SH FLAGS
.TP
\-h, \-\-help
Prints help information.
.TP
\-q, \-\-quiet
Omit any leading labels or symbols. Recommended for use in shell scripts.
.TP
\-s, \-\-silent
Omit any output at all.
.TP
\-V, \-\-version
Prints version information.
.TP
\-v, \-\-verbose [Aliases: \-\-noisy]
Prints more information, like when an item was created.
.\"
.\" ================================
.\"
.SH OPTIONS
.TP
\-f, \-\-format <FORMAT>
Use a programmatic FORMAT. Options include: [csv, json, json-compact, tsv]
.TP
\-t, \-\-stack <STACK> [Or: \-\-topic, \-\-about, \-\-namespace <STACK>]
Manage items in a specific STACK. If no STACK is provided, it will use "sigi"
by default. It's recommended to use shell aliases to access your stacks. (See
.B EXAMPLES
below.)
.TP
\-d, \-\-data\-store <DATA_STORE>
(Advanced) Manage sigi stacks in a specific directory. The default is either
the value of a SIGI_HOME environment variable or your OS-specific home
directory [aliases: dir, directory, store]
.\"
.\" ================================
.\"
.SH SUBCOMMANDS
.TP
-
Read input lines from standard input. Same commands as interactive mode, but
only prints for printing commands. Intended for use in unix pipes
.TP
complete
Move the current item to "<STACK>_history" and mark as completed [aliases: done, finish, fulfill]
.TP
count
Print the total number of items in the stack [aliases: size, length]
.TP
delete
Move the current item to "<STACK>_history" and mark as deleted. [aliases: pop, remove, cancel, drop]
.TP
delete-all
Move all items to "<STACK>_history" and mark as deleted [aliases: purge, pop-all, remove-all, cancel-all, drop-all]
.TP
edit
Edit the content of an item. Other metadata like creation date is left unchanged
.TP
head N
Print the first N items [aliases: top, first]
.TP
help
Prints a help message or the help of the given subcommand(s)
.TP
interactive
Run in an interactive mode [aliases: i]
.TP
is-empty
Prints "true" if stack has zero items, or prints "false" (fails with a nonzero exit code) if the stack does have items [aliases: empty]
.TP
list
Print all items [aliases: ls, snoop, show, all]
.TP
list-stacks
Print all stacks [aliases: stacks]
.TP
move
Move current item to another stack
.TP
move-all
Move all items to another stack
.TP
next
Cycle to the next item; the current item becomes last [aliases: later, cycle, bury]
.TP
peek
Print the first item. (This is the default behavior when no command is given) [aliases: show]
.TP
pick
Move items to the top of stack by their number
.TP
push
Create a new item [aliases: create, add, do, start, new]
.TP
rot
Rotate the three most-current items [aliases: rotate]
.TP
swap
Swap the two most-current items
.TP
tail
Print the last N items [aliases: bottom, last]
.\"
.\" ================================
.\" Note to self: preconv can do utf8 -> troff escapes.
.\"
.SH INTERACTIVE MODE
Use subcommands in interactive mode directly. For example:
.RS
.EX
\t\[u1F334] \[u25B6] push a new thing
Created: a new thing
\[u1F334] \[u25B6] peek
Now: a new thing
\[u1F334] \[u25B6] delete
Deleted: a new thing
Now: nothing
\[u1F334] \[u25B6] exit
exit: Buen bi\[u00E5]he!
.EE
.RE
.PP
No OPTIONS (flags) of subcommands are understood in interactive mode.
.PP
The ; character can be used to separate commands.
.PP
The following additional commands are available:
.RS
.TP
?
Show the short version of \"help\"
.TP
clear
Clear the terminal screen
.TP
use
Change to the specified stack [aliases: stack]
.TP
exit
Quit interactive mode [aliases: quit, q]
.RE
.\"
.\" ================================
.\"
.SH EXAMPLES, CONTRIBUTING, AND SUPPORT
See: https://github.com/sigi-cli/sigi
.\"
.SH AUTHOR
J.R. Hill https://so.dang.cool