Repository navigation
Expand file tree
/
Copy pathhelp.lua
More file actions
68 lines (62 loc) · 6.21 KB
/
Copy pathhelp.lua
File metadata and controls
68 lines (62 loc) · 6.21 KB
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
function PrintHelp()
print("treasury.lua stores key-value pairs in encrypted files called 'lockboxes'\n");
print("usage: lua treasury.lua [action] [lockbox] [key] [value]\n")
print("actions:")
print(" new [lockbox] create a new lockbox")
print(" names [lockbox] list keys in a lockbox")
print(" list [lockbox] list keys in a lockbox, and comments/notes associated with them")
print(" dump [lockbox] dump lockbox in plain text")
print(" add [lockbox] [key] [value] add a key/value pair to a lockbox")
print(" add [lockbox] [key] -g generate a 32bit random string, and add it to a lockbox")
print(" add [lockbox] [key] -generate generate a 32bit random string, and add it to a lockbox")
print(" add [lockbox] [key] -glen <len> generate a random string, and add it to a lockbox")
print(" del [lockbox] [key] remove a key/value pair from a lockbox")
print(" rm [lockbox] [key] remove a key/value pair from a lockbox")
print(" get [lockbox] [key] get the value matching 'key' in a lockbox")
print(" get [lockbox] [key] -o <path> get the value matching 'key' in a lockbox, and write it to <path>")
print(" get [lockbox] [key] -qr get the value matching 'key' in a lockbox, and display as qr code")
print(" get [lockbox] [key] -qr -o <path> get the value matching 'key' in a lockbox, and write as a qr code PNG to <path>")
print(" get [lockbox] [key] -clip get the value matching 'key' in a lockbox, and push it to clipboard")
print(" get [lockbox] [key] -osc52 get the value matching 'key' in a lockbox, and push it to clipboard using xterm's osc52 command")
print(" get [lockbox] [key] -totp get the value matching 'key' in a lockbox, and use it to calculate a totp code")
print(" entry [lockbox] enter 'data entry' mode for localbox")
print(" shell [lockbox] enter 'shell' mode for localbox")
print(" update sync known lockboxes by searching for matching 'sync' files found in the 'sync_in' directory (default ~/.treasury/sync_in)")
print(" update [lockbox] sync specified known lockbox by searching for matching 'sync' files found in the 'sync_in' directory (default ~/.treasury/sync_in)")
print(" sync sync key/value pairs from 'sync' files found in the 'sync_in' directory (default ~/.treasury/sync_in)")
print(" sync [path] sync key/value pairs from a sync or lockbox file(s). 'path' can be a pattern like '/home/user/incoming/*', or an ssh path like 'ssh:myserver/sync/treasury/*.sync'")
print(" sync [path] [path] ... sync key/value pairs from a sync or lockbox file(s). 'path' can be a pattern like '/home/user/incoming/*', or an ssh path like 'ssh:myserver/sync/treasury/*.sync'")
print(" send [path] [dir] send lockbox at <path> to a directory <dir>for syncing")
print(" send [dir] send all known lockboxes to a directory for syncing")
print(" sync-status display last import of imported 'sync' files")
print(" chpw [box] change password for a lockbox")
print(" find [lockbox] [search pattern] find key/value pairs matching 'search pattern'")
print(" import [lockbox] [path] import key/value pairs from a file")
print(" export [lockbox] [path] export key/value pairs to a file")
print(" export [lockbox] [path] -csv export key/value pairs from a csv file")
print(" export [lockbox] [path] -xml export key/value pairs from a xml file")
print(" export [lockbox] [path] -json export key/value pairs from a json file")
print(" export [lockbox] [path] -zcsv export key/value pairs from a pkzipped csv file (with password)")
print(" export [lockbox] [path] -zxml export key/value pairs from a pkzipped xml file (with password)")
print(" export [lockbox] [path] -zjson export key/value pairs from a pkzipped json file (with password)")
print(" export [lockbox] [path] -7zcsv export key/value pairs from a 7zipped csv file (with password)")
print(" export [lockbox] [path] -7zxml export key/value pairs from a 7zipped xml file (with password)")
print(" export [lockbox] [path] -7zjson export key/value pairs from a 7zipped json file (with password)")
print(" show-config print out application config")
print(" config-set [name] [value] change a config value")
print(" version print program version")
print(" -version print program version")
print(" --version print program version")
print(" --help print help")
print(" -help print help")
print(" help print help")
print(" -? print help")
print("\noptions:\n")
print(" -K don't use keyring for getting lockbox password")
print(" -nokeyring don't use keyring for getting lockbox password")
print(" -nosync don't update a lockbox with files from the 'sync_in' directory before names/list/dump/get commands")
print("")
print("The type of file for import and export can be set using the -csv, -xml, -json, -zcsv, -zxml, -zjson, -7zcsv, -7zxml, -7zjson, -scsv, -sxml, -sjson options. Without these the import and export commands will try to guess the filetype.")
print("The import command examines the file at [path] and can open csv, xml and json files, including those that have been packaged/encrypted with pkzip/infozip, 7zip, or simply encrypted with openssl.");
print("The export command uses the extension of the supplied filename to guess the filetype. Thus extensions should be in the form .csv, .zcsv, .7zscv .scsv");
end