mirror of
https://codeberg.org/scip/anydb.git
synced 2025-12-17 20:41:00 +01:00
Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
675d10d8fa | ||
| 659e3472bb | |||
| 1eb5efae0c | |||
|
|
bb5c268ca8 | ||
| a4b6a3cfdf | |||
| c144e99b41 | |||
|
|
2a6a651b91 | ||
|
|
33d638aff0 | ||
| 8a8888a3cf | |||
| a590eaf903 | |||
| cb6abecaf9 | |||
| a777c9cab4 | |||
| 2f652dc57d | |||
|
|
f5f3760e67 | ||
|
|
2253acf19d | ||
| b7e3267695 | |||
|
|
6adeb618b7 | ||
| 66d6bd2a41 |
7
Makefile
7
Makefile
@@ -29,7 +29,7 @@ BUILD = $(shell date +%Y.%m.%d.%H%M%S)
|
|||||||
VERSION := $(if $(filter $(BRANCH), development),$(version)-$(BRANCH)-$(COMMIT)-$(BUILD),$(version))
|
VERSION := $(if $(filter $(BRANCH), development),$(version)-$(BRANCH)-$(COMMIT)-$(BUILD),$(version))
|
||||||
HAVE_POD := $(shell pod2text -h 2>/dev/null)
|
HAVE_POD := $(shell pod2text -h 2>/dev/null)
|
||||||
|
|
||||||
all: $(tool).1 cmd/$(tool).go buildlocal
|
all: $(tool).1 cmd/$(tool).go app/dbentry.pb.go buildlocal
|
||||||
|
|
||||||
%.1: %.pod
|
%.1: %.pod
|
||||||
ifdef HAVE_POD
|
ifdef HAVE_POD
|
||||||
@@ -49,6 +49,11 @@ endif
|
|||||||
# awk '/SYNOPS/{f=1;next} /DESCR/{f=0} f' $*.pod | sed 's/^ //' >> cmd/$*.go
|
# awk '/SYNOPS/{f=1;next} /DESCR/{f=0} f' $*.pod | sed 's/^ //' >> cmd/$*.go
|
||||||
# echo "\`" >> cmd/$*.go
|
# echo "\`" >> cmd/$*.go
|
||||||
|
|
||||||
|
app/dbentry.pb.go: app/dbentry.proto
|
||||||
|
protoc -I=. --go_out=app app/dbentry.proto
|
||||||
|
mv app/github.com/tlinden/anydb/app/dbentry.pb.go app/dbentry.pb.go
|
||||||
|
rm -rf app/github.com
|
||||||
|
|
||||||
buildlocal:
|
buildlocal:
|
||||||
go build -ldflags "-X 'github.com/tlinden/anydb/cfg.VERSION=$(VERSION)'"
|
go build -ldflags "-X 'github.com/tlinden/anydb/cfg.VERSION=$(VERSION)'"
|
||||||
|
|
||||||
|
|||||||
15
README.md
15
README.md
@@ -2,7 +2,10 @@
|
|||||||
|
|
||||||
[](https://github.com/tlinden/anydb/actions)
|
[](https://github.com/tlinden/anydb/actions)
|
||||||
[](https://github.com/tlinden/anydb/blob/master/LICENSE)
|
[](https://github.com/tlinden/anydb/blob/master/LICENSE)
|
||||||
|
[](https://raw.githack.com/wiki/tlinden/anydb/coverage.html)
|
||||||
[](https://goreportcard.com/report/github.com/tlinden/anydb)
|
[](https://goreportcard.com/report/github.com/tlinden/anydb)
|
||||||
|
[](https://github.com/TLINDEN/anydb/releases/latest)
|
||||||
|
[](https://github.com/TLINDEN/anydb/blob/master/anydb.pod)
|
||||||
|
|
||||||
Anydb is a simple to use commandline tool to store anything you'd
|
Anydb is a simple to use commandline tool to store anything you'd
|
||||||
like, even binary files etc. It is a re-implementation of
|
like, even binary files etc. It is a re-implementation of
|
||||||
@@ -27,6 +30,8 @@ reasons:
|
|||||||
- templates for custom output for maximum flexibility
|
- templates for custom output for maximum flexibility
|
||||||
- includes a tiny web server, which serves a restful API
|
- includes a tiny web server, which serves a restful API
|
||||||
|
|
||||||
|
And I wrote a very similar [tool](https://www.daemon.de/projects/dbtool/) 24 years ago and wanted to do it again wit go.
|
||||||
|
|
||||||
**anydb** can do all the things you can do with skate:
|
**anydb** can do all the things you can do with skate:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -71,10 +76,14 @@ anydb set foo bar -t note,important
|
|||||||
anydb list -t important
|
anydb list -t important
|
||||||
|
|
||||||
# beside tags filtering you can also use regexps for searching
|
# beside tags filtering you can also use regexps for searching
|
||||||
|
# note, by default the list command only searches through keys
|
||||||
anydb list '[a-z]+\d'
|
anydb list '[a-z]+\d'
|
||||||
|
|
||||||
|
# do a full text search
|
||||||
|
anydb list '[a-z]+\d' -s
|
||||||
|
|
||||||
# anydb also supports a wide output
|
# anydb also supports a wide output
|
||||||
anydb list -o wide
|
anydb list -m wide
|
||||||
KEY TAGS SIZE AGE VALUE
|
KEY TAGS SIZE AGE VALUE
|
||||||
blah important 4 B 7 seconds ago haha
|
blah important 4 B 7 seconds ago haha
|
||||||
foo 3 B 15 seconds ago bar
|
foo 3 B 15 seconds ago bar
|
||||||
@@ -85,13 +94,13 @@ anydb ls -l
|
|||||||
anydb /
|
anydb /
|
||||||
|
|
||||||
# other outputs are possible as well
|
# other outputs are possible as well
|
||||||
anydb list -o json
|
anydb list -m json
|
||||||
|
|
||||||
# you can backup your database
|
# you can backup your database
|
||||||
anydb export -o backup.json
|
anydb export -o backup.json
|
||||||
|
|
||||||
# and import it somewhere else
|
# and import it somewhere else
|
||||||
anydb import -r backup.json
|
anydb import -i backup.json
|
||||||
|
|
||||||
# you can encrypt entries. anydb asks for a passphrase
|
# you can encrypt entries. anydb asks for a passphrase
|
||||||
# and will do the same when you retrieve the key using the
|
# and will do the same when you retrieve the key using the
|
||||||
|
|||||||
37
TODO.md
37
TODO.md
@@ -1,2 +1,39 @@
|
|||||||
|
## Features
|
||||||
|
|
||||||
- repl
|
- repl
|
||||||
- mime-type => exec app + value
|
- mime-type => exec app + value
|
||||||
|
- add waitgroup to db.go funcs
|
||||||
|
- RestList does not support any params?
|
||||||
|
- lc() incoming tags+keys
|
||||||
|
|
||||||
|
## DB Structure
|
||||||
|
|
||||||
|
- put tags into sub bucket see #1
|
||||||
|
- change structure to:
|
||||||
|
|
||||||
|
data bucket
|
||||||
|
key => {key,value[0:60],isbin:bool}
|
||||||
|
|
||||||
|
value bucket
|
||||||
|
key => value (maybe always use []byte here)
|
||||||
|
|
||||||
|
tags bucket
|
||||||
|
key/tag => tag/key
|
||||||
|
tag/key => tag
|
||||||
|
|
||||||
|
So, list just uses the data bucket, no large contents.
|
||||||
|
A tag search only looksup matching tags, see #1.
|
||||||
|
Only a full text search and get would need to dig into the value bucket.
|
||||||
|
|
||||||
|
A delete would just delete all keys from all values and then:
|
||||||
|
lookup in tags bucket for all key/*, then iterate over the values and
|
||||||
|
remove all tag/key's. Then deleting a key would not leave any residue
|
||||||
|
behind.
|
||||||
|
|
||||||
|
However, maybe change the list command to just list everything and add
|
||||||
|
an extra find command for fulltext or tag search. Maybe still provide
|
||||||
|
filter options in list command but only filter for keys.
|
||||||
|
|
||||||
|
DONE: most of the above, except the tag stuff. manpage needs update and tests.
|
||||||
|
|
||||||
|
maybe stitch the find command and just add -f (full text search) to list.
|
||||||
|
|||||||
586
anydb.1
586
anydb.1
@@ -133,7 +133,7 @@
|
|||||||
.\" ========================================================================
|
.\" ========================================================================
|
||||||
.\"
|
.\"
|
||||||
.IX Title "ANYDB 1"
|
.IX Title "ANYDB 1"
|
||||||
.TH ANYDB 1 "2024-12-22" "1" "User Commands"
|
.TH ANYDB 1 "2024-12-30" "1" "User Commands"
|
||||||
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||||||
.\" way too many mistakes in technical documents.
|
.\" way too many mistakes in technical documents.
|
||||||
.if n .ad l
|
.if n .ad l
|
||||||
@@ -151,14 +151,20 @@ anydb \- a personal key value store
|
|||||||
\& Available Commands:
|
\& Available Commands:
|
||||||
\& completion Generate the autocompletion script for the specified shell
|
\& completion Generate the autocompletion script for the specified shell
|
||||||
\& del Delete key
|
\& del Delete key
|
||||||
|
\& edit Edit a key
|
||||||
\& export Export database to json
|
\& export Export database to json
|
||||||
\& get Retrieve value for a key
|
\& get Retrieve value for a key
|
||||||
\& help Help about any command
|
\& help Help about any command
|
||||||
\& import Import database dump
|
\& import Import database dump
|
||||||
|
\& info info
|
||||||
\& list List database contents
|
\& list List database contents
|
||||||
|
\& man show manual page
|
||||||
|
\& serve run REST API listener
|
||||||
\& set Insert key/value pair
|
\& set Insert key/value pair
|
||||||
\&
|
\&
|
||||||
\& Flags:
|
\& Flags:
|
||||||
|
\& \-b, \-\-bucket string use other bucket (default: data) (default "data")
|
||||||
|
\& \-c, \-\-config string toml config file
|
||||||
\& \-f, \-\-dbfile string DB file to use (default "/home/scip/.config/anydb/default.db")
|
\& \-f, \-\-dbfile string DB file to use (default "/home/scip/.config/anydb/default.db")
|
||||||
\& \-d, \-\-debug Enable debugging
|
\& \-d, \-\-debug Enable debugging
|
||||||
\& \-h, \-\-help help for anydb
|
\& \-h, \-\-help help for anydb
|
||||||
@@ -168,9 +174,581 @@ anydb \- a personal key value store
|
|||||||
.Ve
|
.Ve
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
.IX Header "DESCRIPTION"
|
.IX Header "DESCRIPTION"
|
||||||
Anydb is a simple to use commandline tool to store anything you'd
|
Anydb is a commandline personal key value store, it is simple to use
|
||||||
like, even binary files etc. It uses a key/value store (bbolt) in your
|
and can be used to store anything you'd like, even binary files
|
||||||
home directory.
|
etc. It uses a key/value store (bbolt) in your home directory.
|
||||||
|
.PP
|
||||||
|
The tool provides a number of subcommands to use it, there are global
|
||||||
|
options and each subcommand has its own set of options.
|
||||||
|
.SH "GLOBAL OPTIONS"
|
||||||
|
.IX Header "GLOBAL OPTIONS"
|
||||||
|
.ie n .IP """\-f, \-\-dbfile filename""" 4
|
||||||
|
.el .IP "\f(CW\-f, \-\-dbfile filename\fR" 4
|
||||||
|
.IX Item "-f, --dbfile filename"
|
||||||
|
The default location of your databas is
|
||||||
|
\&\f(CW\*(C`$HOME/.config/anydb/default.db\*(C'\fR. You can change this with the \f(CW\*(C`\-f\*(C'\fR
|
||||||
|
option.
|
||||||
|
.ie n .IP """\-b, \-\-bucket name""" 4
|
||||||
|
.el .IP "\f(CW\-b, \-\-bucket name\fR" 4
|
||||||
|
.IX Item "-b, --bucket name"
|
||||||
|
Data in a bbolt key-value-store are managed in so called
|
||||||
|
buckets. These are kind of namespaces, where each key must be
|
||||||
|
unique. However, a database may contain more than one bucket.
|
||||||
|
.Sp
|
||||||
|
By default anydb uses a bucket named \*(L"data\*(R", but you can change this
|
||||||
|
using the option \f(CW\*(C`\-b\*(C'\fR.
|
||||||
|
.Sp
|
||||||
|
Buckets can be configured to always encrypt values, see \s-1ENCRYTPTION\s0.
|
||||||
|
.ie n .IP """\-c, \-\-config filename""" 4
|
||||||
|
.el .IP "\f(CW\-c, \-\-config filename\fR" 4
|
||||||
|
.IX Item "-c, --config filename"
|
||||||
|
Under normal circumstances you don't need a configuration file. But if
|
||||||
|
you want, you can provide one using the option \f(CW\*(C`\-c\*(C'\fR.
|
||||||
|
.Sp
|
||||||
|
Anydb looks for a couple of default locations for a config file. You
|
||||||
|
only need this option if you want to supply a configuration on a
|
||||||
|
non-standard location. See \s-1CONFIGURATION\s0 for more details.
|
||||||
|
.ie n .IP """\-d, \-\-debug""" 4
|
||||||
|
.el .IP "\f(CW\-d, \-\-debug\fR" 4
|
||||||
|
.IX Item "-d, --debug"
|
||||||
|
Enable debug output.
|
||||||
|
.ie n .IP """\-h, \-\-help""" 4
|
||||||
|
.el .IP "\f(CW\-h, \-\-help\fR" 4
|
||||||
|
.IX Item "-h, --help"
|
||||||
|
Show the usage of anydb.
|
||||||
|
.ie n .IP """\-v, \-\-version""" 4
|
||||||
|
.el .IP "\f(CW\-v, \-\-version\fR" 4
|
||||||
|
.IX Item "-v, --version"
|
||||||
|
Show the program version.
|
||||||
|
.PP
|
||||||
|
All of these options can be used with subcommands as well.
|
||||||
|
.SH "SUBCOMMANDS"
|
||||||
|
.IX Header "SUBCOMMANDS"
|
||||||
|
.SS "completion"
|
||||||
|
.IX Subsection "completion"
|
||||||
|
The \fBcompletion\fR command can be used to setup completion for
|
||||||
|
anydb. Just put something like this into your shell's configuration
|
||||||
|
file:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& source <(anydb completion bash)
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
If you use another shell, specify it instead of bash, of course.
|
||||||
|
.SS "set"
|
||||||
|
.IX Subsection "set"
|
||||||
|
The \fBset\fR command is being used to insert or update a key-value pair.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb set <key> [<value> | \-r <file>] [\-t <tag>] [flags]
|
||||||
|
\&
|
||||||
|
\& Aliases:
|
||||||
|
\& set, add, s, +
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-e, \-\-encrypt encrypt value
|
||||||
|
\& \-r, \-\-file string Filename or \- for STDIN
|
||||||
|
\& \-h, \-\-help help for set
|
||||||
|
\& \-t, \-\-tags tag,tag,... tags, multiple allowed
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
The standard way to insert a new entry is really simple:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& anydb set key value
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
If you don't specify a value, anydb expects you to feed it some data
|
||||||
|
via \s-1STDIN.\s0 For example:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& anydb set key < file
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
You might as well specify a file directly using the \f(CW\*(C`\-f\*(C'\fR option:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& anydb set key \-f file
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
Values can be encrypted using \fBChaCha20Poly1305\fR when you specify the
|
||||||
|
\&\f(CW\*(C`\-e\*(C'\fR option. Anydb will ask you interactively for a passphrase. You
|
||||||
|
can also provide the passphrase using the environment variable
|
||||||
|
\&\f(CW\*(C`ANYDB_PASSWORD\*(C'\fR. To encrypt the value, a cryptographically secure
|
||||||
|
key will be derived from the passphrase using the ArgonID2
|
||||||
|
algorithm. Each value can be encrypted with another passphrase. So,
|
||||||
|
the database itself is not encrypted, just the values.
|
||||||
|
.PP
|
||||||
|
You can supply tags by using the option \f(CW\*(C`\-t\*(C'\fR. Multiple tags can be
|
||||||
|
provided either by separating them with a comma or by using multiple
|
||||||
|
\&\f(CW\*(C`\-t\*(C'\fR parameters:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& anydb set key value \-t tag1,tag2
|
||||||
|
\& anydb set key value \-t tag1 \-t tag2
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
You can later filter entries by tag or by a combination of tags.
|
||||||
|
.PP
|
||||||
|
To edit or modify an entry, just use the \fBset\fR command with the same
|
||||||
|
key, the value in the database will be overwritten with the new
|
||||||
|
value. An alternative option is the \fBedit\fR command, see below.
|
||||||
|
.SS "get"
|
||||||
|
.IX Subsection "get"
|
||||||
|
To retrieve the value of a key, use the \fBget\fR subcommand.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb get <key> [\-o <file>] [\-m <mode>] [\-n \-N] [\-T <tpl>] [flags]
|
||||||
|
\&
|
||||||
|
\& Aliases:
|
||||||
|
\& get, show, g, .
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-h, \-\-help help for get
|
||||||
|
\& \-m, \-\-mode string output format (simple|wide|json|template) (default \*(Aqsimple\*(Aq)
|
||||||
|
\& \-n, \-\-no\-headers omit headers in tables
|
||||||
|
\& \-N, \-\-no\-human do not translate to human readable values
|
||||||
|
\& \-o, \-\-output string output value to file (ignores \-m)
|
||||||
|
\& \-T, \-\-template string go template for \*(Aq\-m template\*(Aq
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
In its simplest form you just call the \fBget\fR subcommand with the key
|
||||||
|
you want to have the value for. The value is being printed to \s-1STDOUT\s0
|
||||||
|
by default:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& anydb get key
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
If the value is binary content, it will not just being printed. In
|
||||||
|
those cases you need to either redirect output into a file or use the
|
||||||
|
option \f(CW\*(C`\-o\*(C'\fR to write to a file:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& anydb get key > file
|
||||||
|
\& anydb get key \-o file
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
If the value is encrypted, you will be asked for the passphrase to
|
||||||
|
decrypt it. If the environment variable \f(CW\*(C`ANYDB_PASSWORD\*(C'\fR is set, its
|
||||||
|
value will be used instead.
|
||||||
|
.PP
|
||||||
|
There are different output modes you can choose from: simple, wide and
|
||||||
|
json. The \*(L"simple\*(R" mode is the default one, it just prints the value
|
||||||
|
as is. The \*(L"wide\*(R" mode prints a tabular output similar to the \fBlist\fR
|
||||||
|
subcommand, see there for more details. The options \f(CW\*(C`\-n\*(C'\fR and \f(CW\*(C`\-N\*(C'\fR
|
||||||
|
have the same meaning as in the list command. The \*(L"json\*(R" mode prints
|
||||||
|
the raw \s-1JSON\s0 representation of the whole database entry. Decryption
|
||||||
|
will only take place in \*(L"simple\*(R" and \*(L"json\*(R" mode. The \*(L"template\*(R" mode
|
||||||
|
provides the most flexibily, it is detailed in the section
|
||||||
|
\&\s-1TEMPLATES\s0.
|
||||||
|
.SS "list"
|
||||||
|
.IX Subsection "list"
|
||||||
|
The \fBlist\fR subcommand displays a list of all database entries.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb list [<filter\-regex> | \-t <tag> ] [\-m <mode>] [\-nNif] [\-T <tpl>] [flags]
|
||||||
|
\&
|
||||||
|
\& Aliases:
|
||||||
|
\& list, ls, /, find, search
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-i, \-\-case\-insensitive filter case insensitive
|
||||||
|
\& \-h, \-\-help help for list
|
||||||
|
\& \-m, \-\-mode string output format (table|wide|json|template), wide is a verbose table. (default \*(Aqtable\*(Aq)
|
||||||
|
\& \-n, \-\-no\-headers omit headers in tables
|
||||||
|
\& \-N, \-\-no\-human do not translate to human readable values
|
||||||
|
\& \-s, \-\-search\-fulltext perform a full text search
|
||||||
|
\& \-t, \-\-tags stringArray tags, multiple allowed
|
||||||
|
\& \-T, \-\-template string go template for \*(Aq\-m template\*(Aq
|
||||||
|
\& \-l, \-\-wide\-output output mode: wide
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
In its simplest form \- without any options \- , the \fBlist\fR command
|
||||||
|
just prints all keys with their values to \s-1STDOUT.\s0 Values are being
|
||||||
|
truncated to maximum of 60 characters, that is, multiline values are
|
||||||
|
not completely shown in order to keep the tabular view readable.
|
||||||
|
.PP
|
||||||
|
To get more informations about each entry, use the \f(CW\*(C`\-o wide\*(C'\fR or \f(CW\*(C`\-l\*(C'\fR
|
||||||
|
option. In addition to the key and value also the size, update
|
||||||
|
timestamp and tags will be printed. Time and size values are converted
|
||||||
|
into a human readable form, you can suppress this behavior with the
|
||||||
|
\&\f(CW\*(C`\-N\*(C'\fR option. You may omit the headers using the option \f(CW\*(C`\-n\*(C'\fR
|
||||||
|
.PP
|
||||||
|
Sometimes you might want to filter the list of entries. Either because
|
||||||
|
your database grew too large or because you're searching for
|
||||||
|
something. In that case you have two options: You may supply one or
|
||||||
|
more tags or provide a filter regexp. To filter by tag, do:
|
||||||
|
.PP
|
||||||
|
.Vb 3
|
||||||
|
\& anydb list \-t tag1
|
||||||
|
\& anydb list \-t tag1,tag2
|
||||||
|
\& anydb list \-t tag1 \-t tag2
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
To filter using a regular expression, do:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& anydb list "foo.*bar"
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
Regular expressions follow the golang \fBre2\fR syntax. For more details
|
||||||
|
about the syntax, refer to
|
||||||
|
<https://github.com/google/re2/wiki/Syntax>. Please note, that this
|
||||||
|
regexp dialect is not \s-1PCRE\s0 compatible, but supports most of its
|
||||||
|
features.
|
||||||
|
.PP
|
||||||
|
If you want to search case insensitive, add the option \f(CW\*(C`\-i\*(C'\fR.
|
||||||
|
.PP
|
||||||
|
By default anydb only searches through the keys. If you want to search
|
||||||
|
through the values as well, then use the \f(CW\*(C`\-s\*(C'\fR option, which enables
|
||||||
|
full-text search.
|
||||||
|
.PP
|
||||||
|
You can \- as with the \fBget\fR command \- use other output modes. The
|
||||||
|
default mode is \*(L"table\*(R". The \*(L"wide\*(R" mode is, as already mentioned, a
|
||||||
|
more detailed table. Also supported is \*(L"json\*(R" mode and \*(L"template\*(R"
|
||||||
|
mode. For details about using templates see \s-1TEMPLATES\s0.
|
||||||
|
.SS "del"
|
||||||
|
.IX Subsection "del"
|
||||||
|
Use the \fBdel\fR command to delete database entries.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb del <key> [flags]
|
||||||
|
\&
|
||||||
|
\& Aliases:
|
||||||
|
\& del, d, rm
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-h, \-\-help help for del
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
The subcommand \fBdel\fR does not provide any further options, it just
|
||||||
|
deletes the entry referred to by the given key. No questions are being
|
||||||
|
asked.
|
||||||
|
.SS "edit"
|
||||||
|
.IX Subsection "edit"
|
||||||
|
The \fBedit\fR command makes it easier to modify larger entries.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb edit <key> [flags]
|
||||||
|
\&
|
||||||
|
\& Aliases:
|
||||||
|
\& edit, modify, mod, ed, vi
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-h, \-\-help help for edit
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
The subcommand \fBedit\fR does not provide any further options. It
|
||||||
|
works like this:
|
||||||
|
.IP "1. Write the value info a temporary file." 4
|
||||||
|
.IX Item "1. Write the value info a temporary file."
|
||||||
|
.PD 0
|
||||||
|
.IP "2. Execute the editor (which one, see below!) with that file." 4
|
||||||
|
.IX Item "2. Execute the editor (which one, see below!) with that file."
|
||||||
|
.IP "3. Now you can edit the file and save+close it when done." 4
|
||||||
|
.IX Item "3. Now you can edit the file and save+close it when done."
|
||||||
|
.IP "4. Anydb picks up the file and if the content has changed, puts its value into the \s-1DB.\s0" 4
|
||||||
|
.IX Item "4. Anydb picks up the file and if the content has changed, puts its value into the DB."
|
||||||
|
.PD
|
||||||
|
.PP
|
||||||
|
By default anydb executes the \f(CW\*(C`vi\*(C'\fR command. You can modify this
|
||||||
|
behavior by setting the environment variable \f(CW\*(C`EDITOR\*(C'\fR appropriately.
|
||||||
|
.PP
|
||||||
|
Please note, that this does not work with binary content!
|
||||||
|
.SS "export"
|
||||||
|
.IX Subsection "export"
|
||||||
|
Since the bbolt database file is not portable across platforms (it is
|
||||||
|
bound to the endianess of the \s-1CPU\s0 it was being created on), you might
|
||||||
|
want to create a backup file of your database. You can do this with
|
||||||
|
the \fBexport\fR subcommand.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb export \-o <json filename> [flags]
|
||||||
|
\&
|
||||||
|
\& Aliases:
|
||||||
|
\& export, dump, backup
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-h, \-\-help help for export
|
||||||
|
\& \-o, \-\-output string output to file
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
The database dump is a \s-1JSON\s0 representation of the whole database and
|
||||||
|
will be printed to the file specified with the \f(CW\*(C`\-o\*(C'\fR option. If you
|
||||||
|
specify \*(L"\-\*(R" as the filename, it will be written to \s-1STDIN.\s0
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& anydb export \-o dump.json
|
||||||
|
\& anydb export \-o \- > dump.json
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
Please note, that encrypted values will not be decrypted. This might
|
||||||
|
change in a future version of anydb.
|
||||||
|
.SS "import"
|
||||||
|
.IX Subsection "import"
|
||||||
|
The \fBimport\fR subcommand can be used to restore a database from a \s-1JSON\s0
|
||||||
|
dump.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb import \-i <json file> [flags]
|
||||||
|
\&
|
||||||
|
\& Aliases:
|
||||||
|
\& import, restore
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-r, \-\-file string Filename or \- for STDIN
|
||||||
|
\& \-h, \-\-help help for import
|
||||||
|
\& \-t, \-\-tags stringArray tags, multiple allowed
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
The \f(CW\*(C`import\*(C'\fR subcommand reads the \s-1JSON\s0 contents from
|
||||||
|
the file specified with the \f(CW\*(C`\-i\*(C'\fR option. If you specify \*(L"\-\*(R" as the
|
||||||
|
filename, it will be read from \s-1STDIN.\s0
|
||||||
|
.PP
|
||||||
|
.Vb 3
|
||||||
|
\& anydb import \-i \- < dump.json
|
||||||
|
\& anydb import \-i dump.json
|
||||||
|
\& cat dump.json | anydb import \-i \-
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
If there is already a database, it will be saved by appending a
|
||||||
|
timestamp and a new database with the contents of the dump will be
|
||||||
|
created.
|
||||||
|
.SS "serve"
|
||||||
|
.IX Subsection "serve"
|
||||||
|
Anydb provides a RESTful \s-1API,\s0 which you can use to manage the database
|
||||||
|
from somewhere else. The \s-1API\s0 does not provide any authentication or
|
||||||
|
any other security measures, so better only use it on localhost.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb serve [\-l host:port] [flags]
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-h, \-\-help help for serve
|
||||||
|
\& \-l, \-\-listen string host:port (default "localhost:8787")
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
To start the listener, just execute the \fBserve\fR subcommand. You can
|
||||||
|
tweak the ip address and tcp port using the \f(CW\*(C`\-l\*(C'\fR option. The listener
|
||||||
|
will not fork and run in the foreground. Logs are being printed to
|
||||||
|
\&\s-1STDOUT\s0 as long as the listener runs.
|
||||||
|
.PP
|
||||||
|
For more details about the \s-1API,\s0 please see the \*(L"\s-1REST API\*(R"\s0 section.
|
||||||
|
.SS "info"
|
||||||
|
.IX Subsection "info"
|
||||||
|
The \fBinfo\fR subcommand shows you some information about your current
|
||||||
|
database.
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb info [flags]
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-h, \-\-help help for info
|
||||||
|
\& \-N, \-\-no\-human do not translate to human readable values
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
Data being shown are: filename and size, number of keys per bucket. If
|
||||||
|
you supply the \f(CW\*(C`\-d\*(C'\fR option (debug), some bbolt internals are being
|
||||||
|
displayed as well.
|
||||||
|
.SS "man"
|
||||||
|
.IX Subsection "man"
|
||||||
|
The \fBman\fR subcommand shows an unformatted text variant of the manual
|
||||||
|
page (which are currently reading).
|
||||||
|
.PP
|
||||||
|
Usage:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& Usage:
|
||||||
|
\& anydb man [flags]
|
||||||
|
\&
|
||||||
|
\& Flags:
|
||||||
|
\& \-h, \-\-help help for man
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
The manual is being piped into the \f(CW\*(C`more\*(C'\fR command, which is being
|
||||||
|
expected to exist according to the \s-1POSIX\s0 standard on all supported
|
||||||
|
unix platforms. It might not work on Windows.
|
||||||
|
.SH "TEMPLATES"
|
||||||
|
.IX Header "TEMPLATES"
|
||||||
|
The \fBget\fR and \fBlist\fR commands support a template feature, which is
|
||||||
|
very handy to create you own kind of formatting. The template syntax
|
||||||
|
being used is the \s-1GO\s0 template language, refer to
|
||||||
|
<https://pkg.go.dev/text/template> for details.
|
||||||
|
.PP
|
||||||
|
Each template operates on one or more entries, no loop construct is
|
||||||
|
required, the template provided applies to every matching entry
|
||||||
|
separatley.
|
||||||
|
.PP
|
||||||
|
The following template variables can be used:
|
||||||
|
.IP "\fBKey\fR \- string" 4
|
||||||
|
.IX Item "Key - string"
|
||||||
|
.PD 0
|
||||||
|
.IP "\fBValue\fR \- string" 4
|
||||||
|
.IX Item "Value - string"
|
||||||
|
.IP "\fBBin\fR \- []byte" 4
|
||||||
|
.IX Item "Bin - []byte"
|
||||||
|
.IP "\fBCreated\fR \- time.Time" 4
|
||||||
|
.IX Item "Created - time.Time"
|
||||||
|
.IP "\fBTags\fR \- []string" 4
|
||||||
|
.IX Item "Tags - []string"
|
||||||
|
.IP "\fBEncrypted\fR bool" 4
|
||||||
|
.IX Item "Encrypted bool"
|
||||||
|
.PD
|
||||||
|
.PP
|
||||||
|
Prepend a single dot (\*(L".\*(R") before each variable name.
|
||||||
|
.PP
|
||||||
|
Here are some examples how to use the feature:
|
||||||
|
.PP
|
||||||
|
Only show the keys of all entries:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& anydb list \-m template \-T "{{ .Key }}"
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
Format the list in a way so that is possible to evaluate it in a
|
||||||
|
shell:
|
||||||
|
.PP
|
||||||
|
.Vb 2
|
||||||
|
\& eval $(anydb get foo \-m template \-T "key=\*(Aq{{ .Key }}\*(Aq value=\*(Aq{{ .Value }}\*(Aq ts=\*(Aq{{ .Created}}\*(Aq")
|
||||||
|
\& echo "Key: $key, Value: $value"
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
Print the values in \s-1CSV\s0 format \s-1ONLY\s0 if they have some tag:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& anydb list \-m template \-T "{{ if .Tags }}{{ .Key }},{{ .Value }},{{ .Created}}{{ end }}"
|
||||||
|
.Ve
|
||||||
|
.SH "CONFIGURATION"
|
||||||
|
.IX Header "CONFIGURATION"
|
||||||
|
Anydb looks at the following locations for a configuration file, in
|
||||||
|
that order:
|
||||||
|
.ie n .IP """$HOME/.config/anydb/anydb.toml""" 4
|
||||||
|
.el .IP "\f(CW$HOME/.config/anydb/anydb.toml\fR" 4
|
||||||
|
.IX Item "$HOME/.config/anydb/anydb.toml"
|
||||||
|
.PD 0
|
||||||
|
.ie n .IP """$HOME/.anydb.toml""" 4
|
||||||
|
.el .IP "\f(CW$HOME/.anydb.toml\fR" 4
|
||||||
|
.IX Item "$HOME/.anydb.toml"
|
||||||
|
.ie n .IP """anydb.toml"" in the current directory" 4
|
||||||
|
.el .IP "\f(CWanydb.toml\fR in the current directory" 4
|
||||||
|
.IX Item "anydb.toml in the current directory"
|
||||||
|
.ie n .IP "or specify one using ""\-c""" 4
|
||||||
|
.el .IP "or specify one using \f(CW\-c\fR" 4
|
||||||
|
.IX Item "or specify one using -c"
|
||||||
|
.PD
|
||||||
|
.PP
|
||||||
|
The configuration format uses the \s-1TOML\s0 language, refer to
|
||||||
|
<https://toml.io/en/> for more details. The key names correspond to
|
||||||
|
the commandline options in most cases.
|
||||||
|
.PP
|
||||||
|
Configuration follows a certain precedence: the files are tried to be
|
||||||
|
read in the given order, followed by commandline options. That is, the
|
||||||
|
last configuration file wins, unless the user provides a commandline
|
||||||
|
option, then this setting will be taken.
|
||||||
|
.PP
|
||||||
|
A complete configuration file might look like this:
|
||||||
|
.PP
|
||||||
|
.Vb 7
|
||||||
|
\& # defaults
|
||||||
|
\& dbfile = "~/.config/anydb/default.db"
|
||||||
|
\& dbbucket = "data"
|
||||||
|
\& noheaders = false
|
||||||
|
\& nohumanize = false
|
||||||
|
\& encrypt = false
|
||||||
|
\& listen = "localhost:8787"
|
||||||
|
\&
|
||||||
|
\& # different setups for different buckets
|
||||||
|
\& [buckets.data]
|
||||||
|
\& encrypt = true
|
||||||
|
\&
|
||||||
|
\& [buckets.test]
|
||||||
|
\& encrypt = false
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
Under normal circumstances you don't need a configuration
|
||||||
|
file. However, if you want to use different buckets, then this might
|
||||||
|
be a handy option. Buckets are being configured in ini-style with the
|
||||||
|
term \*(L"bucket.\*(R" followed by the bucket name. In the example above we
|
||||||
|
enable encryption for the default bucket \*(L"data\*(R" and disable it for a
|
||||||
|
bucket \*(L"test\*(R". To use different buckets, use the \f(CW\*(C`\-b\*(C'\fR option.
|
||||||
|
.SH "REST API"
|
||||||
|
.IX Header "REST API"
|
||||||
|
The subcommand \fBserve\fR starts a simple \s-1HTTP\s0 service, which responds
|
||||||
|
to RESTful \s-1HTTP\s0 requests. The listener responds to all requests with a
|
||||||
|
\&\s-1JSON\s0 encoded response. The response contains the status and the
|
||||||
|
content \- if any \- of the requested resource.
|
||||||
|
.PP
|
||||||
|
The following requests are supported:
|
||||||
|
.IP "\fB\s-1GET\s0 /anydb/v1/\fR" 4
|
||||||
|
.IX Item "GET /anydb/v1/"
|
||||||
|
Returns a \s-1JSON\s0 encoded list of all entries.
|
||||||
|
.IP "\fB\s-1GET\s0 /anydb/v1/key\fR" 4
|
||||||
|
.IX Item "GET /anydb/v1/key"
|
||||||
|
Returns the \s-1JSON\s0 encoded entry, if found.
|
||||||
|
.IP "\fB\s-1PUT\s0 /anydb/v1/\fR" 4
|
||||||
|
.IX Item "PUT /anydb/v1/"
|
||||||
|
Create an entry. Expects a \s-1JSON\s0 encoded request object in \s-1POST\s0 data.
|
||||||
|
.IP "\fB\s-1DELETE\s0 /anydb/v1/key\fR" 4
|
||||||
|
.IX Item "DELETE /anydb/v1/key"
|
||||||
|
Delete an entry.
|
||||||
|
.PP
|
||||||
|
Some curl example calls to the \s-1API:\s0
|
||||||
|
.PP
|
||||||
|
Post a new key:
|
||||||
|
curl \-X \s-1PUT\s0 localhost:8787/anydb/v1/ \e
|
||||||
|
\-H 'Content\-Type: application/json' \e
|
||||||
|
\-d '{\*(L"key\*(R":\*(L"foo\*(R",\*(L"val\*(R":\*(L"bar\*(R"}'
|
||||||
|
.PP
|
||||||
|
Retrieve the value:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& curl localhost:8787/anydb/v1/foo
|
||||||
|
.Ve
|
||||||
|
.PP
|
||||||
|
List all keys:
|
||||||
|
.PP
|
||||||
|
.Vb 1
|
||||||
|
\& curl localhost:8787/anydb/v1/
|
||||||
|
.Ve
|
||||||
|
.SH "BUGS"
|
||||||
|
.IX Header "BUGS"
|
||||||
|
In order to report a bug, unexpected behavior, feature requests
|
||||||
|
or to submit a patch, please open an issue on github:
|
||||||
|
<https://github.com/TLINDEN/anydb/issues>.
|
||||||
|
.PP
|
||||||
|
Please repeat the failing command with debugging enabled \f(CW\*(C`\-d\*(C'\fR and
|
||||||
|
include the output in the issue.
|
||||||
|
.SH "LIMITATIONS"
|
||||||
|
.IX Header "LIMITATIONS"
|
||||||
|
The \s-1REST API\s0 list request doesn't provide any filtering capabilities yet.
|
||||||
.SH "LICENSE"
|
.SH "LICENSE"
|
||||||
.IX Header "LICENSE"
|
.IX Header "LICENSE"
|
||||||
This software is licensed under the \s-1GNU GENERAL PUBLIC LICENSE\s0 version 3.
|
This software is licensed under the \s-1GNU GENERAL PUBLIC LICENSE\s0 version 3.
|
||||||
|
|||||||
563
anydb.pod
563
anydb.pod
@@ -11,14 +11,20 @@ anydb - a personal key value store
|
|||||||
Available Commands:
|
Available Commands:
|
||||||
completion Generate the autocompletion script for the specified shell
|
completion Generate the autocompletion script for the specified shell
|
||||||
del Delete key
|
del Delete key
|
||||||
|
edit Edit a key
|
||||||
export Export database to json
|
export Export database to json
|
||||||
get Retrieve value for a key
|
get Retrieve value for a key
|
||||||
help Help about any command
|
help Help about any command
|
||||||
import Import database dump
|
import Import database dump
|
||||||
|
info info
|
||||||
list List database contents
|
list List database contents
|
||||||
|
man show manual page
|
||||||
|
serve run REST API listener
|
||||||
set Insert key/value pair
|
set Insert key/value pair
|
||||||
|
|
||||||
Flags:
|
Flags:
|
||||||
|
-b, --bucket string use other bucket (default: data) (default "data")
|
||||||
|
-c, --config string toml config file
|
||||||
-f, --dbfile string DB file to use (default "/home/scip/.config/anydb/default.db")
|
-f, --dbfile string DB file to use (default "/home/scip/.config/anydb/default.db")
|
||||||
-d, --debug Enable debugging
|
-d, --debug Enable debugging
|
||||||
-h, --help help for anydb
|
-h, --help help for anydb
|
||||||
@@ -26,11 +32,562 @@ anydb - a personal key value store
|
|||||||
|
|
||||||
Use "anydb [command] --help" for more information about a command.
|
Use "anydb [command] --help" for more information about a command.
|
||||||
|
|
||||||
|
|
||||||
=head1 DESCRIPTION
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
Anydb is a simple to use commandline tool to store anything you'd
|
Anydb is a commandline personal key value store, it is simple to use
|
||||||
like, even binary files etc. It uses a key/value store (bbolt) in your
|
and can be used to store anything you'd like, even binary files
|
||||||
home directory.
|
etc. It uses a key/value store (bbolt) in your home directory.
|
||||||
|
|
||||||
|
The tool provides a number of subcommands to use it, there are global
|
||||||
|
options and each subcommand has its own set of options.
|
||||||
|
|
||||||
|
=head1 GLOBAL OPTIONS
|
||||||
|
|
||||||
|
=over
|
||||||
|
|
||||||
|
=item C<-f, --dbfile filename>
|
||||||
|
|
||||||
|
The default location of your databas is
|
||||||
|
C<$HOME/.config/anydb/default.db>. You can change this with the C<-f>
|
||||||
|
option.
|
||||||
|
|
||||||
|
=item C<-b, --bucket name>
|
||||||
|
|
||||||
|
Data in a bbolt key-value-store are managed in so called
|
||||||
|
buckets. These are kind of namespaces, where each key must be
|
||||||
|
unique. However, a database may contain more than one bucket.
|
||||||
|
|
||||||
|
By default anydb uses a bucket named "data", but you can change this
|
||||||
|
using the option C<-b>.
|
||||||
|
|
||||||
|
Buckets can be configured to always encrypt values, see L<ENCRYTPTION>.
|
||||||
|
|
||||||
|
=item C<-c, --config filename>
|
||||||
|
|
||||||
|
Under normal circumstances you don't need a configuration file. But if
|
||||||
|
you want, you can provide one using the option C<-c>.
|
||||||
|
|
||||||
|
Anydb looks for a couple of default locations for a config file. You
|
||||||
|
only need this option if you want to supply a configuration on a
|
||||||
|
non-standard location. See L<CONFIGURATION> for more details.
|
||||||
|
|
||||||
|
=item C<-d, --debug>
|
||||||
|
|
||||||
|
Enable debug output.
|
||||||
|
|
||||||
|
=item C<-h, --help>
|
||||||
|
|
||||||
|
Show the usage of anydb.
|
||||||
|
|
||||||
|
=item C<-v, --version>
|
||||||
|
|
||||||
|
Show the program version.
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
All of these options can be used with subcommands as well.
|
||||||
|
|
||||||
|
=head1 SUBCOMMANDS
|
||||||
|
|
||||||
|
=head2 completion
|
||||||
|
|
||||||
|
The B<completion> command can be used to setup completion for
|
||||||
|
anydb. Just put something like this into your shell's configuration
|
||||||
|
file:
|
||||||
|
|
||||||
|
source <(anydb completion bash)
|
||||||
|
|
||||||
|
If you use another shell, specify it instead of bash, of course.
|
||||||
|
|
||||||
|
=head2 set
|
||||||
|
|
||||||
|
The B<set> command is being used to insert or update a key-value pair.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb set <key> [<value> | -r <file>] [-t <tag>] [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
set, add, s, +
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-e, --encrypt encrypt value
|
||||||
|
-r, --file string Filename or - for STDIN
|
||||||
|
-h, --help help for set
|
||||||
|
-t, --tags tag,tag,... tags, multiple allowed
|
||||||
|
|
||||||
|
The standard way to insert a new entry is really simple:
|
||||||
|
|
||||||
|
anydb set key value
|
||||||
|
|
||||||
|
If you don't specify a value, anydb expects you to feed it some data
|
||||||
|
via STDIN. For example:
|
||||||
|
|
||||||
|
anydb set key < file
|
||||||
|
|
||||||
|
You might as well specify a file directly using the C<-f> option:
|
||||||
|
|
||||||
|
anydb set key -f file
|
||||||
|
|
||||||
|
Values can be encrypted using B<ChaCha20Poly1305> when you specify the
|
||||||
|
C<-e> option. Anydb will ask you interactively for a passphrase. You
|
||||||
|
can also provide the passphrase using the environment variable
|
||||||
|
C<ANYDB_PASSWORD>. To encrypt the value, a cryptographically secure
|
||||||
|
key will be derived from the passphrase using the ArgonID2
|
||||||
|
algorithm. Each value can be encrypted with another passphrase. So,
|
||||||
|
the database itself is not encrypted, just the values.
|
||||||
|
|
||||||
|
You can supply tags by using the option C<-t>. Multiple tags can be
|
||||||
|
provided either by separating them with a comma or by using multiple
|
||||||
|
C<-t> parameters:
|
||||||
|
|
||||||
|
anydb set key value -t tag1,tag2
|
||||||
|
anydb set key value -t tag1 -t tag2
|
||||||
|
|
||||||
|
You can later filter entries by tag or by a combination of tags.
|
||||||
|
|
||||||
|
To edit or modify an entry, just use the B<set> command with the same
|
||||||
|
key, the value in the database will be overwritten with the new
|
||||||
|
value. An alternative option is the B<edit> command, see below.
|
||||||
|
|
||||||
|
=head2 get
|
||||||
|
|
||||||
|
To retrieve the value of a key, use the B<get> subcommand.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb get <key> [-o <file>] [-m <mode>] [-n -N] [-T <tpl>] [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
get, show, g, .
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for get
|
||||||
|
-m, --mode string output format (simple|wide|json|template) (default 'simple')
|
||||||
|
-n, --no-headers omit headers in tables
|
||||||
|
-N, --no-human do not translate to human readable values
|
||||||
|
-o, --output string output value to file (ignores -m)
|
||||||
|
-T, --template string go template for '-m template'
|
||||||
|
|
||||||
|
In its simplest form you just call the B<get> subcommand with the key
|
||||||
|
you want to have the value for. The value is being printed to STDOUT
|
||||||
|
by default:
|
||||||
|
|
||||||
|
anydb get key
|
||||||
|
|
||||||
|
If the value is binary content, it will not just being printed. In
|
||||||
|
those cases you need to either redirect output into a file or use the
|
||||||
|
option C<-o> to write to a file:
|
||||||
|
|
||||||
|
anydb get key > file
|
||||||
|
anydb get key -o file
|
||||||
|
|
||||||
|
If the value is encrypted, you will be asked for the passphrase to
|
||||||
|
decrypt it. If the environment variable C<ANYDB_PASSWORD> is set, its
|
||||||
|
value will be used instead.
|
||||||
|
|
||||||
|
There are different output modes you can choose from: simple, wide and
|
||||||
|
json. The "simple" mode is the default one, it just prints the value
|
||||||
|
as is. The "wide" mode prints a tabular output similar to the B<list>
|
||||||
|
subcommand, see there for more details. The options C<-n> and C<-N>
|
||||||
|
have the same meaning as in the list command. The "json" mode prints
|
||||||
|
the raw JSON representation of the whole database entry. Decryption
|
||||||
|
will only take place in "simple" and "json" mode. The "template" mode
|
||||||
|
provides the most flexibily, it is detailed in the section
|
||||||
|
L<TEMPLATES>.
|
||||||
|
|
||||||
|
=head2 list
|
||||||
|
|
||||||
|
The B<list> subcommand displays a list of all database entries.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb list [<filter-regex> | -t <tag> ] [-m <mode>] [-nNif] [-T <tpl>] [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
list, ls, /, find, search
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-i, --case-insensitive filter case insensitive
|
||||||
|
-h, --help help for list
|
||||||
|
-m, --mode string output format (table|wide|json|template), wide is a verbose table. (default 'table')
|
||||||
|
-n, --no-headers omit headers in tables
|
||||||
|
-N, --no-human do not translate to human readable values
|
||||||
|
-s, --search-fulltext perform a full text search
|
||||||
|
-t, --tags stringArray tags, multiple allowed
|
||||||
|
-T, --template string go template for '-m template'
|
||||||
|
-l, --wide-output output mode: wide
|
||||||
|
|
||||||
|
In its simplest form - without any options - , the B<list> command
|
||||||
|
just prints all keys with their values to STDOUT. Values are being
|
||||||
|
truncated to maximum of 60 characters, that is, multiline values are
|
||||||
|
not completely shown in order to keep the tabular view readable.
|
||||||
|
|
||||||
|
To get more informations about each entry, use the C<-o wide> or C<-l>
|
||||||
|
option. In addition to the key and value also the size, update
|
||||||
|
timestamp and tags will be printed. Time and size values are converted
|
||||||
|
into a human readable form, you can suppress this behavior with the
|
||||||
|
C<-N> option. You may omit the headers using the option C<-n>
|
||||||
|
|
||||||
|
Sometimes you might want to filter the list of entries. Either because
|
||||||
|
your database grew too large or because you're searching for
|
||||||
|
something. In that case you have two options: You may supply one or
|
||||||
|
more tags or provide a filter regexp. To filter by tag, do:
|
||||||
|
|
||||||
|
anydb list -t tag1
|
||||||
|
anydb list -t tag1,tag2
|
||||||
|
anydb list -t tag1 -t tag2
|
||||||
|
|
||||||
|
To filter using a regular expression, do:
|
||||||
|
|
||||||
|
anydb list "foo.*bar"
|
||||||
|
|
||||||
|
Regular expressions follow the golang B<re2> syntax. For more details
|
||||||
|
about the syntax, refer to
|
||||||
|
L<https://github.com/google/re2/wiki/Syntax>. Please note, that this
|
||||||
|
regexp dialect is not PCRE compatible, but supports most of its
|
||||||
|
features.
|
||||||
|
|
||||||
|
If you want to search case insensitive, add the option C<-i>.
|
||||||
|
|
||||||
|
By default anydb only searches through the keys. If you want to search
|
||||||
|
through the values as well, then use the C<-s> option, which enables
|
||||||
|
full-text search.
|
||||||
|
|
||||||
|
You can - as with the B<get> command - use other output modes. The
|
||||||
|
default mode is "table". The "wide" mode is, as already mentioned, a
|
||||||
|
more detailed table. Also supported is "json" mode and "template"
|
||||||
|
mode. For details about using templates see L<TEMPLATES>.
|
||||||
|
|
||||||
|
=head2 del
|
||||||
|
|
||||||
|
Use the B<del> command to delete database entries.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb del <key> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
del, d, rm
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for del
|
||||||
|
|
||||||
|
The subcommand B<del> does not provide any further options, it just
|
||||||
|
deletes the entry referred to by the given key. No questions are being
|
||||||
|
asked.
|
||||||
|
|
||||||
|
=head2 edit
|
||||||
|
|
||||||
|
The B<edit> command makes it easier to modify larger entries.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb edit <key> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
edit, modify, mod, ed, vi
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for edit
|
||||||
|
|
||||||
|
The subcommand B<edit> does not provide any further options. It
|
||||||
|
works like this:
|
||||||
|
|
||||||
|
=over
|
||||||
|
|
||||||
|
=item 1. Write the value info a temporary file.
|
||||||
|
|
||||||
|
=item 2. Execute the editor (which one, see below!) with that file.
|
||||||
|
|
||||||
|
=item 3. Now you can edit the file and save+close it when done.
|
||||||
|
|
||||||
|
=item 4. Anydb picks up the file and if the content has changed, puts its value into the DB.
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
By default anydb executes the C<vi> command. You can modify this
|
||||||
|
behavior by setting the environment variable C<EDITOR> appropriately.
|
||||||
|
|
||||||
|
Please note, that this does not work with binary content!
|
||||||
|
|
||||||
|
=head2 export
|
||||||
|
|
||||||
|
Since the bbolt database file is not portable across platforms (it is
|
||||||
|
bound to the endianess of the CPU it was being created on), you might
|
||||||
|
want to create a backup file of your database. You can do this with
|
||||||
|
the B<export> subcommand.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb export -o <json filename> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
export, dump, backup
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for export
|
||||||
|
-o, --output string output to file
|
||||||
|
|
||||||
|
The database dump is a JSON representation of the whole database and
|
||||||
|
will be printed to the file specified with the C<-o> option. If you
|
||||||
|
specify "-" as the filename, it will be written to STDIN.
|
||||||
|
|
||||||
|
anydb export -o dump.json
|
||||||
|
anydb export -o - > dump.json
|
||||||
|
|
||||||
|
Please note, that encrypted values will not be decrypted. This might
|
||||||
|
change in a future version of anydb.
|
||||||
|
|
||||||
|
=head2 import
|
||||||
|
|
||||||
|
The B<import> subcommand can be used to restore a database from a JSON
|
||||||
|
dump.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb import -i <json file> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
import, restore
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-r, --file string Filename or - for STDIN
|
||||||
|
-h, --help help for import
|
||||||
|
-t, --tags stringArray tags, multiple allowed
|
||||||
|
|
||||||
|
The C<import> subcommand reads the JSON contents from
|
||||||
|
the file specified with the C<-i> option. If you specify "-" as the
|
||||||
|
filename, it will be read from STDIN.
|
||||||
|
|
||||||
|
anydb import -i - < dump.json
|
||||||
|
anydb import -i dump.json
|
||||||
|
cat dump.json | anydb import -i -
|
||||||
|
|
||||||
|
If there is already a database, it will be saved by appending a
|
||||||
|
timestamp and a new database with the contents of the dump will be
|
||||||
|
created.
|
||||||
|
|
||||||
|
=head2 serve
|
||||||
|
|
||||||
|
Anydb provides a RESTful API, which you can use to manage the database
|
||||||
|
from somewhere else. The API does not provide any authentication or
|
||||||
|
any other security measures, so better only use it on localhost.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb serve [-l host:port] [flags]
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for serve
|
||||||
|
-l, --listen string host:port (default "localhost:8787")
|
||||||
|
|
||||||
|
To start the listener, just execute the B<serve> subcommand. You can
|
||||||
|
tweak the ip address and tcp port using the C<-l> option. The listener
|
||||||
|
will not fork and run in the foreground. Logs are being printed to
|
||||||
|
STDOUT as long as the listener runs.
|
||||||
|
|
||||||
|
For more details about the API, please see the L<REST API> section.
|
||||||
|
|
||||||
|
=head2 info
|
||||||
|
|
||||||
|
The B<info> subcommand shows you some information about your current
|
||||||
|
database.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb info [flags]
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for info
|
||||||
|
-N, --no-human do not translate to human readable values
|
||||||
|
|
||||||
|
Data being shown are: filename and size, number of keys per bucket. If
|
||||||
|
you supply the C<-d> option (debug), some bbolt internals are being
|
||||||
|
displayed as well.
|
||||||
|
|
||||||
|
=head2 man
|
||||||
|
|
||||||
|
The B<man> subcommand shows an unformatted text variant of the manual
|
||||||
|
page (which are currently reading).
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb man [flags]
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for man
|
||||||
|
|
||||||
|
The manual is being piped into the C<more> command, which is being
|
||||||
|
expected to exist according to the POSIX standard on all supported
|
||||||
|
unix platforms. It might not work on Windows.
|
||||||
|
|
||||||
|
=head1 TEMPLATES
|
||||||
|
|
||||||
|
The B<get> and B<list> commands support a template feature, which is
|
||||||
|
very handy to create you own kind of formatting. The template syntax
|
||||||
|
being used is the GO template language, refer to
|
||||||
|
L<https://pkg.go.dev/text/template> for details.
|
||||||
|
|
||||||
|
Each template operates on one or more entries, no loop construct is
|
||||||
|
required, the template provided applies to every matching entry
|
||||||
|
separatley.
|
||||||
|
|
||||||
|
The following template variables can be used:
|
||||||
|
|
||||||
|
=over
|
||||||
|
|
||||||
|
=item B<Key> - string
|
||||||
|
|
||||||
|
=item B<Value> - string
|
||||||
|
|
||||||
|
=item B<Bin> - []byte
|
||||||
|
|
||||||
|
=item B<Created> - time.Time
|
||||||
|
|
||||||
|
=item B<Tags> - []string
|
||||||
|
|
||||||
|
=item B<Encrypted> bool
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
Prepend a single dot (".") before each variable name.
|
||||||
|
|
||||||
|
Here are some examples how to use the feature:
|
||||||
|
|
||||||
|
Only show the keys of all entries:
|
||||||
|
|
||||||
|
anydb list -m template -T "{{ .Key }}"
|
||||||
|
|
||||||
|
Format the list in a way so that is possible to evaluate it in a
|
||||||
|
shell:
|
||||||
|
|
||||||
|
eval $(anydb get foo -m template -T "key='{{ .Key }}' value='{{ .Value }}' ts='{{ .Created}}'")
|
||||||
|
echo "Key: $key, Value: $value"
|
||||||
|
|
||||||
|
Print the values in CSV format ONLY if they have some tag:
|
||||||
|
|
||||||
|
anydb list -m template -T "{{ if .Tags }}{{ .Key }},{{ .Value }},{{ .Created}}{{ end }}"
|
||||||
|
|
||||||
|
|
||||||
|
=head1 CONFIGURATION
|
||||||
|
|
||||||
|
Anydb looks at the following locations for a configuration file, in
|
||||||
|
that order:
|
||||||
|
|
||||||
|
=over
|
||||||
|
|
||||||
|
=item C<$HOME/.config/anydb/anydb.toml>
|
||||||
|
|
||||||
|
=item C<$HOME/.anydb.toml>
|
||||||
|
|
||||||
|
=item C<anydb.toml> in the current directory
|
||||||
|
|
||||||
|
=item or specify one using C<-c>
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
The configuration format uses the TOML language, refer to
|
||||||
|
L<https://toml.io/en/> for more details. The key names correspond to
|
||||||
|
the commandline options in most cases.
|
||||||
|
|
||||||
|
Configuration follows a certain precedence: the files are tried to be
|
||||||
|
read in the given order, followed by commandline options. That is, the
|
||||||
|
last configuration file wins, unless the user provides a commandline
|
||||||
|
option, then this setting will be taken.
|
||||||
|
|
||||||
|
A complete configuration file might look like this:
|
||||||
|
|
||||||
|
# defaults
|
||||||
|
dbfile = "~/.config/anydb/default.db"
|
||||||
|
dbbucket = "data"
|
||||||
|
noheaders = false
|
||||||
|
nohumanize = false
|
||||||
|
encrypt = false
|
||||||
|
listen = "localhost:8787"
|
||||||
|
|
||||||
|
# different setups for different buckets
|
||||||
|
[buckets.data]
|
||||||
|
encrypt = true
|
||||||
|
|
||||||
|
[buckets.test]
|
||||||
|
encrypt = false
|
||||||
|
|
||||||
|
Under normal circumstances you don't need a configuration
|
||||||
|
file. However, if you want to use different buckets, then this might
|
||||||
|
be a handy option. Buckets are being configured in ini-style with the
|
||||||
|
term "bucket." followed by the bucket name. In the example above we
|
||||||
|
enable encryption for the default bucket "data" and disable it for a
|
||||||
|
bucket "test". To use different buckets, use the C<-b> option.
|
||||||
|
|
||||||
|
|
||||||
|
=head1 REST API
|
||||||
|
|
||||||
|
The subcommand B<serve> starts a simple HTTP service, which responds
|
||||||
|
to RESTful HTTP requests. The listener responds to all requests with a
|
||||||
|
JSON encoded response. The response contains the status and the
|
||||||
|
content - if any - of the requested resource.
|
||||||
|
|
||||||
|
The following requests are supported:
|
||||||
|
|
||||||
|
=over
|
||||||
|
|
||||||
|
=item B<GET /anydb/v1/>
|
||||||
|
|
||||||
|
Returns a JSON encoded list of all entries.
|
||||||
|
|
||||||
|
=item B<GET /anydb/v1/key>
|
||||||
|
|
||||||
|
Returns the JSON encoded entry, if found.
|
||||||
|
|
||||||
|
=item B<PUT /anydb/v1/>
|
||||||
|
|
||||||
|
Create an entry. Expects a JSON encoded request object in POST data.
|
||||||
|
|
||||||
|
=item B<DELETE /anydb/v1/key>
|
||||||
|
|
||||||
|
Delete an entry.
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
Some curl example calls to the API:
|
||||||
|
|
||||||
|
Post a new key:
|
||||||
|
curl -X PUT localhost:8787/anydb/v1/ \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{"key":"foo","val":"bar"}'
|
||||||
|
|
||||||
|
Retrieve the value:
|
||||||
|
|
||||||
|
curl localhost:8787/anydb/v1/foo
|
||||||
|
|
||||||
|
List all keys:
|
||||||
|
|
||||||
|
curl localhost:8787/anydb/v1/
|
||||||
|
|
||||||
|
=head1 BUGS
|
||||||
|
|
||||||
|
In order to report a bug, unexpected behavior, feature requests
|
||||||
|
or to submit a patch, please open an issue on github:
|
||||||
|
L<https://github.com/TLINDEN/anydb/issues>.
|
||||||
|
|
||||||
|
Please repeat the failing command with debugging enabled C<-d> and
|
||||||
|
include the output in the issue.
|
||||||
|
|
||||||
|
=head1 LIMITATIONS
|
||||||
|
|
||||||
|
The REST API list request doesn't provide any filtering capabilities yet.
|
||||||
|
|
||||||
=head1 LICENSE
|
=head1 LICENSE
|
||||||
|
|
||||||
|
|||||||
49
app/attr.go
49
app/attr.go
@@ -20,30 +20,34 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"strings"
|
||||||
"unicode/utf8"
|
"unicode/utf8"
|
||||||
)
|
)
|
||||||
|
|
||||||
type DbAttr struct {
|
type DbAttr struct {
|
||||||
Key string
|
Key string
|
||||||
Val string
|
Preview string
|
||||||
Bin []byte
|
Val []byte
|
||||||
Args []string
|
Args []string
|
||||||
Tags []string
|
Tags []string
|
||||||
File string
|
File string
|
||||||
Encrypted bool
|
Encrypted bool
|
||||||
|
Binary bool
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// check if value is to be read from a file or stdin, setup preview
|
||||||
|
// text according to flags, lowercase key
|
||||||
func (attr *DbAttr) ParseKV() error {
|
func (attr *DbAttr) ParseKV() error {
|
||||||
|
attr.Key = strings.ToLower(attr.Args[0])
|
||||||
|
|
||||||
switch len(attr.Args) {
|
switch len(attr.Args) {
|
||||||
case 1:
|
case 1:
|
||||||
// 1 arg = key + read from file or stdin
|
// 1 arg = key + read from file or stdin
|
||||||
attr.Key = attr.Args[0]
|
|
||||||
if attr.File == "" {
|
if attr.File == "" {
|
||||||
attr.File = "-"
|
attr.File = "-"
|
||||||
}
|
}
|
||||||
case 2:
|
case 2:
|
||||||
attr.Key = attr.Args[0]
|
attr.Val = []byte(attr.Args[1])
|
||||||
attr.Val = attr.Args[1]
|
|
||||||
|
|
||||||
if attr.Args[1] == "-" {
|
if attr.Args[1] == "-" {
|
||||||
attr.File = "-"
|
attr.File = "-"
|
||||||
@@ -51,7 +55,29 @@ func (attr *DbAttr) ParseKV() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if attr.File != "" {
|
if attr.File != "" {
|
||||||
return attr.GetFileValue()
|
if err := attr.GetFileValue(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case attr.Binary:
|
||||||
|
attr.Preview = "<binary-content>"
|
||||||
|
case attr.Encrypted:
|
||||||
|
attr.Preview = "<encrypted-content>"
|
||||||
|
default:
|
||||||
|
if len(attr.Val) > MaxValueWidth {
|
||||||
|
attr.Preview = string(attr.Val)[0:MaxValueWidth] + "..."
|
||||||
|
|
||||||
|
if strings.Contains(attr.Preview, "\n") {
|
||||||
|
parts := strings.Split(attr.Preview, "\n")
|
||||||
|
if len(parts) > 0 {
|
||||||
|
attr.Preview = parts[0]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
attr.Preview = string(attr.Val)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -82,11 +108,12 @@ func (attr *DbAttr) GetFileValue() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// poor man's text file test
|
// poor man's text file test
|
||||||
sdata := string(data)
|
attr.Val = data
|
||||||
if utf8.ValidString(sdata) {
|
|
||||||
attr.Val = sdata
|
if utf8.ValidString(string(data)) {
|
||||||
|
attr.Binary = false
|
||||||
} else {
|
} else {
|
||||||
attr.Bin = data
|
attr.Binary = true
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// read from console stdin
|
// read from console stdin
|
||||||
@@ -101,7 +128,7 @@ func (attr *DbAttr) GetFileValue() error {
|
|||||||
data += input + "\n"
|
data += input + "\n"
|
||||||
}
|
}
|
||||||
|
|
||||||
attr.Val = data
|
attr.Val = []byte(data)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
@@ -18,7 +18,6 @@ package app
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"crypto/rand"
|
"crypto/rand"
|
||||||
"encoding/base64"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
@@ -104,7 +103,7 @@ func GetRandom(size int, capacity int) ([]byte, error) {
|
|||||||
// modifying it.
|
// modifying it.
|
||||||
//
|
//
|
||||||
// The cipher text consists of:
|
// The cipher text consists of:
|
||||||
// base64(password-salt) + base64(12 byte nonce + ciphertext + 16 byte mac)
|
// password-salt) + (12 byte nonce + ciphertext + 16 byte mac)
|
||||||
func Encrypt(pass []byte, attr *DbAttr) error {
|
func Encrypt(pass []byte, attr *DbAttr) error {
|
||||||
key, err := DeriveKey(pass, nil)
|
key, err := DeriveKey(pass, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -116,25 +115,17 @@ func Encrypt(pass []byte, attr *DbAttr) error {
|
|||||||
return fmt.Errorf("failed to create AEAD cipher: %w", err)
|
return fmt.Errorf("failed to create AEAD cipher: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
var plain []byte
|
total := aead.NonceSize() + len(attr.Val) + aead.Overhead()
|
||||||
if attr.Val != "" {
|
|
||||||
plain = []byte(attr.Val)
|
|
||||||
} else {
|
|
||||||
plain = attr.Bin
|
|
||||||
}
|
|
||||||
|
|
||||||
total := aead.NonceSize() + len(plain) + aead.Overhead()
|
|
||||||
|
|
||||||
nonce, err := GetRandom(aead.NonceSize(), total)
|
nonce, err := GetRandom(aead.NonceSize(), total)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
cipher := aead.Seal(nonce, nonce, plain, nil)
|
cipher := aead.Seal(nonce, nonce, attr.Val, nil)
|
||||||
|
|
||||||
attr.Bin = nil
|
attr.Val = append(attr.Val, key.Salt...)
|
||||||
attr.Val = base64.RawStdEncoding.EncodeToString(key.Salt) +
|
attr.Val = append(attr.Val, cipher...)
|
||||||
base64.RawStdEncoding.EncodeToString(cipher)
|
|
||||||
|
|
||||||
attr.Encrypted = true
|
attr.Encrypted = true
|
||||||
|
|
||||||
@@ -142,21 +133,17 @@ func Encrypt(pass []byte, attr *DbAttr) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Do the reverse
|
// Do the reverse
|
||||||
func Decrypt(pass []byte, cipherb64 string) ([]byte, error) {
|
func Decrypt(pass []byte, cipherb []byte) ([]byte, error) {
|
||||||
salt, err := base64.RawStdEncoding.Strict().DecodeString(cipherb64[0:B64SaltLen])
|
if len(cipherb) < B64SaltLen {
|
||||||
if err != nil {
|
return nil, fmt.Errorf("encrypted cipher block too small")
|
||||||
return nil, fmt.Errorf("failed to encode to base64: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
key, err := DeriveKey(pass, salt)
|
key, err := DeriveKey(pass, cipherb[0:B64SaltLen])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
cipher, err := base64.RawStdEncoding.Strict().DecodeString(cipherb64[B64SaltLen:])
|
cipher := cipherb[B64SaltLen:]
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to encode to base64: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
aead, err := chacha20poly1305.New(key.Key)
|
aead, err := chacha20poly1305.New(key.Key)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
253
app/db.go
253
app/db.go
@@ -27,6 +27,8 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
bolt "go.etcd.io/bbolt"
|
bolt "go.etcd.io/bbolt"
|
||||||
|
"google.golang.org/protobuf/proto"
|
||||||
|
timestamppb "google.golang.org/protobuf/types/known/timestamppb"
|
||||||
)
|
)
|
||||||
|
|
||||||
const MaxValueWidth int = 60
|
const MaxValueWidth int = 60
|
||||||
@@ -38,17 +40,6 @@ type DB struct {
|
|||||||
DB *bolt.DB
|
DB *bolt.DB
|
||||||
}
|
}
|
||||||
|
|
||||||
type DbEntry struct {
|
|
||||||
Id string `json:"id"`
|
|
||||||
Key string `json:"key"`
|
|
||||||
Value string `json:"value"`
|
|
||||||
Encrypted bool `json:"encrypted"`
|
|
||||||
Bin []byte `json:"bin"`
|
|
||||||
Tags []string `json:"tags"`
|
|
||||||
Created time.Time `json:"created"`
|
|
||||||
Size int
|
|
||||||
}
|
|
||||||
|
|
||||||
type BucketInfo struct {
|
type BucketInfo struct {
|
||||||
Name string
|
Name string
|
||||||
Keys int
|
Keys int
|
||||||
@@ -62,33 +53,7 @@ type DbInfo struct {
|
|||||||
Path string
|
Path string
|
||||||
}
|
}
|
||||||
|
|
||||||
// Post process an entry for list output.
|
type DbEntries []*DbEntry
|
||||||
// Do NOT call it during write processing!
|
|
||||||
func (entry *DbEntry) Normalize() {
|
|
||||||
entry.Size = len(entry.Value)
|
|
||||||
|
|
||||||
if entry.Encrypted {
|
|
||||||
entry.Value = "<encrypted-content>"
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(entry.Bin) > 0 {
|
|
||||||
entry.Value = "<binary-content>"
|
|
||||||
entry.Size = len(entry.Bin)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Contains(entry.Value, "\n") {
|
|
||||||
parts := strings.Split(entry.Value, "\n")
|
|
||||||
if len(parts) > 0 {
|
|
||||||
entry.Value = parts[0]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(entry.Value) > MaxValueWidth {
|
|
||||||
entry.Value = entry.Value[0:MaxValueWidth] + "..."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type DbEntries []DbEntry
|
|
||||||
|
|
||||||
type DbTag struct {
|
type DbTag struct {
|
||||||
Keys []string `json:"key"`
|
Keys []string `json:"key"`
|
||||||
@@ -120,7 +85,7 @@ func (db *DB) Close() error {
|
|||||||
return db.DB.Close()
|
return db.DB.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (db *DB) List(attr *DbAttr) (DbEntries, error) {
|
func (db *DB) List(attr *DbAttr, fulltext bool) (DbEntries, error) {
|
||||||
if err := db.Open(); err != nil {
|
if err := db.Open(); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -134,27 +99,43 @@ func (db *DB) List(attr *DbAttr) (DbEntries, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
err := db.DB.View(func(tx *bolt.Tx) error {
|
err := db.DB.View(func(tx *bolt.Tx) error {
|
||||||
|
root := tx.Bucket([]byte(db.Bucket))
|
||||||
|
if root == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
bucket := tx.Bucket([]byte(db.Bucket))
|
bucket := root.Bucket([]byte("meta"))
|
||||||
if bucket == nil {
|
if bucket == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
err := bucket.ForEach(func(key, jsonentry []byte) error {
|
databucket := root.Bucket([]byte("data"))
|
||||||
|
if databucket == nil {
|
||||||
|
return fmt.Errorf("failed to retrieve data sub bucket")
|
||||||
|
}
|
||||||
|
|
||||||
|
err := bucket.ForEach(func(key, pbentry []byte) error {
|
||||||
var entry DbEntry
|
var entry DbEntry
|
||||||
if err := json.Unmarshal(jsonentry, &entry); err != nil {
|
if err := proto.Unmarshal(pbentry, &entry); err != nil {
|
||||||
return fmt.Errorf("failed to unmarshal from json: %w", err)
|
return fmt.Errorf("failed to unmarshal from protobuf: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
entry.Value = databucket.Get([]byte(entry.Key)) // empty is ok
|
||||||
|
|
||||||
var include bool
|
var include bool
|
||||||
|
|
||||||
switch {
|
switch {
|
||||||
case filter != nil:
|
case filter != nil:
|
||||||
if filter.MatchString(entry.Value) ||
|
if filter.MatchString(entry.Key) ||
|
||||||
filter.MatchString(entry.Key) ||
|
|
||||||
filter.MatchString(strings.Join(entry.Tags, " ")) {
|
filter.MatchString(strings.Join(entry.Tags, " ")) {
|
||||||
include = true
|
include = true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if !entry.Binary && !include && fulltext {
|
||||||
|
if filter.MatchString(string(entry.Value)) {
|
||||||
|
include = true
|
||||||
|
}
|
||||||
|
}
|
||||||
case len(attr.Tags) > 0:
|
case len(attr.Tags) > 0:
|
||||||
for _, search := range attr.Tags {
|
for _, search := range attr.Tags {
|
||||||
for _, tag := range entry.Tags {
|
for _, tag := range entry.Tags {
|
||||||
@@ -173,7 +154,7 @@ func (db *DB) List(attr *DbAttr) (DbEntries, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if include {
|
if include {
|
||||||
entries = append(entries, entry)
|
entries = append(entries, &entry)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -181,6 +162,7 @@ func (db *DB) List(attr *DbAttr) (DbEntries, error) {
|
|||||||
|
|
||||||
return err
|
return err
|
||||||
})
|
})
|
||||||
|
|
||||||
return entries, err
|
return entries, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -192,30 +174,36 @@ func (db *DB) Set(attr *DbAttr) error {
|
|||||||
|
|
||||||
entry := DbEntry{
|
entry := DbEntry{
|
||||||
Key: attr.Key,
|
Key: attr.Key,
|
||||||
Value: attr.Val,
|
Binary: attr.Binary,
|
||||||
Bin: attr.Bin,
|
|
||||||
Tags: attr.Tags,
|
Tags: attr.Tags,
|
||||||
Encrypted: attr.Encrypted,
|
Encrypted: attr.Encrypted,
|
||||||
Created: time.Now(),
|
Created: timestamppb.Now(),
|
||||||
|
Size: uint64(len(attr.Val)),
|
||||||
|
Preview: attr.Preview,
|
||||||
}
|
}
|
||||||
|
|
||||||
// check if the entry already exists and if yes, check if it has
|
// check if the entry already exists and if yes, check if it has
|
||||||
// any tags. if so, we initialize our update struct with these
|
// any tags. if so, we initialize our update struct with these
|
||||||
// tags unless it has new tags configured.
|
// tags unless it has new tags configured.
|
||||||
err := db.DB.View(func(tx *bolt.Tx) error {
|
err := db.DB.View(func(tx *bolt.Tx) error {
|
||||||
bucket := tx.Bucket([]byte(db.Bucket))
|
root := tx.Bucket([]byte(db.Bucket))
|
||||||
|
if root == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
bucket := root.Bucket([]byte("meta"))
|
||||||
if bucket == nil {
|
if bucket == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
jsonentry := bucket.Get([]byte(entry.Key))
|
pbentry := bucket.Get([]byte(entry.Key))
|
||||||
if jsonentry == nil {
|
if pbentry == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
var oldentry DbEntry
|
var oldentry DbEntry
|
||||||
if err := json.Unmarshal(jsonentry, &oldentry); err != nil {
|
if err := proto.Unmarshal(pbentry, &oldentry); err != nil {
|
||||||
return fmt.Errorf("failed to unmarshal from json: %w", err)
|
return fmt.Errorf("failed to unmarshal from protobuf: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(oldentry.Tags) > 0 && len(entry.Tags) == 0 {
|
if len(oldentry.Tags) > 0 && len(entry.Tags) == 0 {
|
||||||
@@ -230,19 +218,39 @@ func (db *DB) Set(attr *DbAttr) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// marshall our data
|
||||||
|
pbentry, err := proto.Marshal(&entry)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to marshall protobuf: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
err = db.DB.Update(func(tx *bolt.Tx) error {
|
err = db.DB.Update(func(tx *bolt.Tx) error {
|
||||||
// insert data
|
// create root bucket
|
||||||
bucket, err := tx.CreateBucketIfNotExists([]byte(db.Bucket))
|
root, err := tx.CreateBucketIfNotExists([]byte(db.Bucket))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to create DB bucket: %w", err)
|
return fmt.Errorf("failed to create DB bucket: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
jsonentry, err := json.Marshal(entry)
|
// create meta bucket
|
||||||
|
bucket, err := root.CreateBucketIfNotExists([]byte("meta"))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to marshall json: %w", err)
|
return fmt.Errorf("failed to create DB meta sub bucket: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = bucket.Put([]byte(entry.Key), []byte(jsonentry))
|
// write meta data
|
||||||
|
err = bucket.Put([]byte(entry.Key), []byte(pbentry))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to insert data: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// create data bucket
|
||||||
|
databucket, err := root.CreateBucketIfNotExists([]byte("data"))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to create DB data sub bucket: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// write value
|
||||||
|
err = databucket.Put([]byte(entry.Key), attr.Val)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to insert data: %w", err)
|
return fmt.Errorf("failed to insert data: %w", err)
|
||||||
}
|
}
|
||||||
@@ -266,21 +274,48 @@ func (db *DB) Get(attr *DbAttr) (*DbEntry, error) {
|
|||||||
entry := DbEntry{}
|
entry := DbEntry{}
|
||||||
|
|
||||||
err := db.DB.View(func(tx *bolt.Tx) error {
|
err := db.DB.View(func(tx *bolt.Tx) error {
|
||||||
bucket := tx.Bucket([]byte(db.Bucket))
|
// root bucket
|
||||||
|
root := tx.Bucket([]byte(db.Bucket))
|
||||||
|
if root == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// get meta sub bucket
|
||||||
|
bucket := root.Bucket([]byte("meta"))
|
||||||
if bucket == nil {
|
if bucket == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
jsonentry := bucket.Get([]byte(attr.Key))
|
// retrieve meta data
|
||||||
if jsonentry == nil {
|
pbentry := bucket.Get([]byte(attr.Key))
|
||||||
// FIXME: shall we return a key not found error?
|
if pbentry == nil {
|
||||||
return nil
|
return fmt.Errorf("no such key: %s", attr.Key)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := json.Unmarshal(jsonentry, &entry); err != nil {
|
// put into struct
|
||||||
return fmt.Errorf("failed to unmarshal from json: %w", err)
|
if err := proto.Unmarshal(pbentry, &entry); err != nil {
|
||||||
|
return fmt.Errorf("failed to unmarshal from protobuf: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// get data sub bucket
|
||||||
|
databucket := root.Bucket([]byte("data"))
|
||||||
|
if databucket == nil {
|
||||||
|
return fmt.Errorf("failed to retrieve data sub bucket")
|
||||||
|
}
|
||||||
|
|
||||||
|
// retrieve actual data value
|
||||||
|
value := databucket.Get([]byte(attr.Key))
|
||||||
|
if len(value) == 0 {
|
||||||
|
return fmt.Errorf("no such key: %s", attr.Key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// we need to make a copy of it, otherwise we'll get an
|
||||||
|
// "unexpected fault address" error
|
||||||
|
vc := make([]byte, len(value))
|
||||||
|
copy(vc, value)
|
||||||
|
|
||||||
|
entry.Value = vc
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -317,7 +352,7 @@ func (db *DB) Import(attr *DbAttr) (string, error) {
|
|||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
if attr.Val == "" {
|
if len(attr.Val) == 0 {
|
||||||
return "", errors.New("empty json file")
|
return "", errors.New("empty json file")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -345,22 +380,41 @@ func (db *DB) Import(attr *DbAttr) (string, error) {
|
|||||||
defer db.Close()
|
defer db.Close()
|
||||||
|
|
||||||
err := db.DB.Update(func(tx *bolt.Tx) error {
|
err := db.DB.Update(func(tx *bolt.Tx) error {
|
||||||
// insert data
|
// create root bucket
|
||||||
bucket, err := tx.CreateBucketIfNotExists([]byte(db.Bucket))
|
root, err := tx.CreateBucketIfNotExists([]byte(db.Bucket))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to create bucket: %w", err)
|
return fmt.Errorf("failed to create DB bucket: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// create meta bucket
|
||||||
|
bucket, err := root.CreateBucketIfNotExists([]byte("meta"))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to create DB meta sub bucket: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, entry := range entries {
|
for _, entry := range entries {
|
||||||
jsonentry, err := json.Marshal(entry)
|
pbentry, err := proto.Marshal(entry)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to marshall json: %w", err)
|
return fmt.Errorf("failed to marshall protobuf: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = bucket.Put([]byte(entry.Key), []byte(jsonentry))
|
// write meta data
|
||||||
|
err = bucket.Put([]byte(entry.Key), []byte(pbentry))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to insert data into DB: %w", err)
|
return fmt.Errorf("failed to insert data into DB: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// create data bucket
|
||||||
|
databucket, err := root.CreateBucketIfNotExists([]byte("data"))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to create DB data sub bucket: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// write value
|
||||||
|
err = databucket.Put([]byte(entry.Key), entry.Value)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to insert data: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -417,3 +471,56 @@ func (db *DB) Info() (*DbInfo, error) {
|
|||||||
|
|
||||||
return info, err
|
return info, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (db *DB) Getall(attr *DbAttr) (DbEntries, error) {
|
||||||
|
if err := db.Open(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer db.Close()
|
||||||
|
|
||||||
|
var entries DbEntries
|
||||||
|
|
||||||
|
err := db.DB.View(func(tx *bolt.Tx) error {
|
||||||
|
// root bucket
|
||||||
|
root := tx.Bucket([]byte(db.Bucket))
|
||||||
|
if root == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// get meta sub bucket
|
||||||
|
bucket := root.Bucket([]byte("meta"))
|
||||||
|
if bucket == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// get data sub bucket
|
||||||
|
databucket := root.Bucket([]byte("data"))
|
||||||
|
if databucket == nil {
|
||||||
|
return fmt.Errorf("failed to retrieve data sub bucket")
|
||||||
|
}
|
||||||
|
|
||||||
|
// iterate over all db entries in meta sub bucket
|
||||||
|
err := bucket.ForEach(func(key, pbentry []byte) error {
|
||||||
|
var entry DbEntry
|
||||||
|
if err := proto.Unmarshal(pbentry, &entry); err != nil {
|
||||||
|
return fmt.Errorf("failed to unmarshal from protobuf: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// retrieve the value from the data sub bucket
|
||||||
|
value := databucket.Get([]byte(entry.Key))
|
||||||
|
|
||||||
|
// we need to make a copy of it, otherwise we'll get an
|
||||||
|
// "unexpected fault address" error
|
||||||
|
vc := make([]byte, len(value))
|
||||||
|
copy(vc, value)
|
||||||
|
|
||||||
|
entry.Value = vc
|
||||||
|
entries = append(entries, &entry)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
return err
|
||||||
|
})
|
||||||
|
return entries, err
|
||||||
|
}
|
||||||
|
|||||||
210
app/dbentry.pb.go
Normal file
210
app/dbentry.pb.go
Normal file
@@ -0,0 +1,210 @@
|
|||||||
|
// -*-c++-*-
|
||||||
|
|
||||||
|
// Code generated by protoc-gen-go. DO NOT EDIT.
|
||||||
|
// versions:
|
||||||
|
// protoc-gen-go v1.36.1
|
||||||
|
// protoc v3.21.12
|
||||||
|
// source: app/dbentry.proto
|
||||||
|
|
||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
|
||||||
|
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
|
||||||
|
timestamppb "google.golang.org/protobuf/types/known/timestamppb"
|
||||||
|
reflect "reflect"
|
||||||
|
sync "sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// Verify that this generated code is sufficiently up-to-date.
|
||||||
|
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
|
||||||
|
// Verify that runtime/protoimpl is sufficiently up-to-date.
|
||||||
|
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
|
||||||
|
)
|
||||||
|
|
||||||
|
type DbEntry struct {
|
||||||
|
state protoimpl.MessageState `protogen:"open.v1"`
|
||||||
|
Id string `protobuf:"bytes,1,opt,name=Id,proto3" json:"Id,omitempty"`
|
||||||
|
Key string `protobuf:"bytes,2,opt,name=Key,proto3" json:"Key,omitempty"`
|
||||||
|
Preview string `protobuf:"bytes,3,opt,name=Preview,proto3" json:"Preview,omitempty"`
|
||||||
|
Tags []string `protobuf:"bytes,4,rep,name=Tags,proto3" json:"Tags,omitempty"`
|
||||||
|
Created *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=Created,proto3" json:"Created,omitempty"`
|
||||||
|
Size uint64 `protobuf:"varint,6,opt,name=Size,proto3" json:"Size,omitempty"`
|
||||||
|
Encrypted bool `protobuf:"varint,7,opt,name=Encrypted,proto3" json:"Encrypted,omitempty"`
|
||||||
|
Binary bool `protobuf:"varint,8,opt,name=Binary,proto3" json:"Binary,omitempty"`
|
||||||
|
Value []byte `protobuf:"bytes,9,opt,name=Value,proto3" json:"Value,omitempty"`
|
||||||
|
unknownFields protoimpl.UnknownFields
|
||||||
|
sizeCache protoimpl.SizeCache
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) Reset() {
|
||||||
|
*x = DbEntry{}
|
||||||
|
mi := &file_app_dbentry_proto_msgTypes[0]
|
||||||
|
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||||
|
ms.StoreMessageInfo(mi)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) String() string {
|
||||||
|
return protoimpl.X.MessageStringOf(x)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (*DbEntry) ProtoMessage() {}
|
||||||
|
|
||||||
|
func (x *DbEntry) ProtoReflect() protoreflect.Message {
|
||||||
|
mi := &file_app_dbentry_proto_msgTypes[0]
|
||||||
|
if x != nil {
|
||||||
|
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||||
|
if ms.LoadMessageInfo() == nil {
|
||||||
|
ms.StoreMessageInfo(mi)
|
||||||
|
}
|
||||||
|
return ms
|
||||||
|
}
|
||||||
|
return mi.MessageOf(x)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deprecated: Use DbEntry.ProtoReflect.Descriptor instead.
|
||||||
|
func (*DbEntry) Descriptor() ([]byte, []int) {
|
||||||
|
return file_app_dbentry_proto_rawDescGZIP(), []int{0}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetId() string {
|
||||||
|
if x != nil {
|
||||||
|
return x.Id
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetKey() string {
|
||||||
|
if x != nil {
|
||||||
|
return x.Key
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetPreview() string {
|
||||||
|
if x != nil {
|
||||||
|
return x.Preview
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetTags() []string {
|
||||||
|
if x != nil {
|
||||||
|
return x.Tags
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetCreated() *timestamppb.Timestamp {
|
||||||
|
if x != nil {
|
||||||
|
return x.Created
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetSize() uint64 {
|
||||||
|
if x != nil {
|
||||||
|
return x.Size
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetEncrypted() bool {
|
||||||
|
if x != nil {
|
||||||
|
return x.Encrypted
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetBinary() bool {
|
||||||
|
if x != nil {
|
||||||
|
return x.Binary
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *DbEntry) GetValue() []byte {
|
||||||
|
if x != nil {
|
||||||
|
return x.Value
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var File_app_dbentry_proto protoreflect.FileDescriptor
|
||||||
|
|
||||||
|
var file_app_dbentry_proto_rawDesc = []byte{
|
||||||
|
0x0a, 0x11, 0x61, 0x70, 0x70, 0x2f, 0x64, 0x62, 0x65, 0x6e, 0x74, 0x72, 0x79, 0x2e, 0x70, 0x72,
|
||||||
|
0x6f, 0x74, 0x6f, 0x12, 0x03, 0x61, 0x70, 0x70, 0x1a, 0x1f, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65,
|
||||||
|
0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2f, 0x74, 0x69, 0x6d, 0x65, 0x73, 0x74,
|
||||||
|
0x61, 0x6d, 0x70, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x22, 0xef, 0x01, 0x0a, 0x07, 0x44, 0x62,
|
||||||
|
0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x0e, 0x0a, 0x02, 0x49, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28,
|
||||||
|
0x09, 0x52, 0x02, 0x49, 0x64, 0x12, 0x10, 0x0a, 0x03, 0x4b, 0x65, 0x79, 0x18, 0x02, 0x20, 0x01,
|
||||||
|
0x28, 0x09, 0x52, 0x03, 0x4b, 0x65, 0x79, 0x12, 0x18, 0x0a, 0x07, 0x50, 0x72, 0x65, 0x76, 0x69,
|
||||||
|
0x65, 0x77, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07, 0x50, 0x72, 0x65, 0x76, 0x69, 0x65,
|
||||||
|
0x77, 0x12, 0x12, 0x0a, 0x04, 0x54, 0x61, 0x67, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x09, 0x52,
|
||||||
|
0x04, 0x54, 0x61, 0x67, 0x73, 0x12, 0x34, 0x0a, 0x07, 0x43, 0x72, 0x65, 0x61, 0x74, 0x65, 0x64,
|
||||||
|
0x18, 0x05, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x1a, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e,
|
||||||
|
0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x54, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61,
|
||||||
|
0x6d, 0x70, 0x52, 0x07, 0x43, 0x72, 0x65, 0x61, 0x74, 0x65, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x53,
|
||||||
|
0x69, 0x7a, 0x65, 0x18, 0x06, 0x20, 0x01, 0x28, 0x04, 0x52, 0x04, 0x53, 0x69, 0x7a, 0x65, 0x12,
|
||||||
|
0x1c, 0x0a, 0x09, 0x45, 0x6e, 0x63, 0x72, 0x79, 0x70, 0x74, 0x65, 0x64, 0x18, 0x07, 0x20, 0x01,
|
||||||
|
0x28, 0x08, 0x52, 0x09, 0x45, 0x6e, 0x63, 0x72, 0x79, 0x70, 0x74, 0x65, 0x64, 0x12, 0x16, 0x0a,
|
||||||
|
0x06, 0x42, 0x69, 0x6e, 0x61, 0x72, 0x79, 0x18, 0x08, 0x20, 0x01, 0x28, 0x08, 0x52, 0x06, 0x42,
|
||||||
|
0x69, 0x6e, 0x61, 0x72, 0x79, 0x12, 0x14, 0x0a, 0x05, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x18, 0x09,
|
||||||
|
0x20, 0x01, 0x28, 0x0c, 0x52, 0x05, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x42, 0x1e, 0x5a, 0x1c, 0x67,
|
||||||
|
0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x74, 0x6c, 0x69, 0x6e, 0x64, 0x65,
|
||||||
|
0x6e, 0x2f, 0x61, 0x6e, 0x79, 0x64, 0x62, 0x2f, 0x61, 0x70, 0x70, 0x62, 0x06, 0x70, 0x72, 0x6f,
|
||||||
|
0x74, 0x6f, 0x33,
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
file_app_dbentry_proto_rawDescOnce sync.Once
|
||||||
|
file_app_dbentry_proto_rawDescData = file_app_dbentry_proto_rawDesc
|
||||||
|
)
|
||||||
|
|
||||||
|
func file_app_dbentry_proto_rawDescGZIP() []byte {
|
||||||
|
file_app_dbentry_proto_rawDescOnce.Do(func() {
|
||||||
|
file_app_dbentry_proto_rawDescData = protoimpl.X.CompressGZIP(file_app_dbentry_proto_rawDescData)
|
||||||
|
})
|
||||||
|
return file_app_dbentry_proto_rawDescData
|
||||||
|
}
|
||||||
|
|
||||||
|
var file_app_dbentry_proto_msgTypes = make([]protoimpl.MessageInfo, 1)
|
||||||
|
var file_app_dbentry_proto_goTypes = []any{
|
||||||
|
(*DbEntry)(nil), // 0: app.DbEntry
|
||||||
|
(*timestamppb.Timestamp)(nil), // 1: google.protobuf.Timestamp
|
||||||
|
}
|
||||||
|
var file_app_dbentry_proto_depIdxs = []int32{
|
||||||
|
1, // 0: app.DbEntry.Created:type_name -> google.protobuf.Timestamp
|
||||||
|
1, // [1:1] is the sub-list for method output_type
|
||||||
|
1, // [1:1] is the sub-list for method input_type
|
||||||
|
1, // [1:1] is the sub-list for extension type_name
|
||||||
|
1, // [1:1] is the sub-list for extension extendee
|
||||||
|
0, // [0:1] is the sub-list for field type_name
|
||||||
|
}
|
||||||
|
|
||||||
|
func init() { file_app_dbentry_proto_init() }
|
||||||
|
func file_app_dbentry_proto_init() {
|
||||||
|
if File_app_dbentry_proto != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
type x struct{}
|
||||||
|
out := protoimpl.TypeBuilder{
|
||||||
|
File: protoimpl.DescBuilder{
|
||||||
|
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
|
||||||
|
RawDescriptor: file_app_dbentry_proto_rawDesc,
|
||||||
|
NumEnums: 0,
|
||||||
|
NumMessages: 1,
|
||||||
|
NumExtensions: 0,
|
||||||
|
NumServices: 0,
|
||||||
|
},
|
||||||
|
GoTypes: file_app_dbentry_proto_goTypes,
|
||||||
|
DependencyIndexes: file_app_dbentry_proto_depIdxs,
|
||||||
|
MessageInfos: file_app_dbentry_proto_msgTypes,
|
||||||
|
}.Build()
|
||||||
|
File_app_dbentry_proto = out.File
|
||||||
|
file_app_dbentry_proto_rawDesc = nil
|
||||||
|
file_app_dbentry_proto_goTypes = nil
|
||||||
|
file_app_dbentry_proto_depIdxs = nil
|
||||||
|
}
|
||||||
20
app/dbentry.proto
Normal file
20
app/dbentry.proto
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
// -*-c++-*-
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
package app;
|
||||||
|
|
||||||
|
import "google/protobuf/timestamp.proto";
|
||||||
|
|
||||||
|
option go_package = "github.com/tlinden/anydb/app";
|
||||||
|
|
||||||
|
message DbEntry {
|
||||||
|
string Id = 1;
|
||||||
|
string Key = 2;
|
||||||
|
string Preview = 3;
|
||||||
|
repeated string Tags = 4;
|
||||||
|
google.protobuf.Timestamp Created = 5;
|
||||||
|
uint64 Size = 6;
|
||||||
|
bool Encrypted = 7;
|
||||||
|
bool Binary = 8;
|
||||||
|
bytes Value = 9;
|
||||||
|
}
|
||||||
@@ -26,23 +26,25 @@ import (
|
|||||||
"github.com/tlinden/anydb/common"
|
"github.com/tlinden/anydb/common"
|
||||||
)
|
)
|
||||||
|
|
||||||
var Version string = "v0.0.6"
|
var Version string = "v0.1.0"
|
||||||
|
|
||||||
type BucketConfig struct {
|
type BucketConfig struct {
|
||||||
Encrypt bool
|
Encrypt bool
|
||||||
}
|
}
|
||||||
|
|
||||||
type Config struct {
|
type Config struct {
|
||||||
Debug bool
|
Debug bool
|
||||||
Dbfile string
|
Dbfile string
|
||||||
Dbbucket string
|
Dbbucket string
|
||||||
Template string
|
Template string
|
||||||
Mode string // wide, table, yaml, json
|
Mode string // wide, table, yaml, json
|
||||||
NoHeaders bool
|
NoHeaders bool
|
||||||
NoHumanize bool
|
NoHumanize bool
|
||||||
Encrypt bool // one entry
|
Encrypt bool // one entry
|
||||||
Listen string
|
CaseInsensitive bool
|
||||||
Buckets map[string]BucketConfig // config file only
|
Fulltext bool
|
||||||
|
Listen string
|
||||||
|
Buckets map[string]BucketConfig // config file only
|
||||||
|
|
||||||
Tags []string // internal
|
Tags []string // internal
|
||||||
DB *app.DB // internal
|
DB *app.DB // internal
|
||||||
|
|||||||
512
cmd/anydb.go
512
cmd/anydb.go
@@ -1,19 +1,3 @@
|
|||||||
/*
|
|
||||||
Copyright © 2024 Thomas von Dein
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
*/
|
|
||||||
package cmd
|
package cmd
|
||||||
|
|
||||||
var manpage = `
|
var manpage = `
|
||||||
@@ -28,14 +12,20 @@ SYNOPSIS
|
|||||||
Available Commands:
|
Available Commands:
|
||||||
completion Generate the autocompletion script for the specified shell
|
completion Generate the autocompletion script for the specified shell
|
||||||
del Delete key
|
del Delete key
|
||||||
|
edit Edit a key
|
||||||
export Export database to json
|
export Export database to json
|
||||||
get Retrieve value for a key
|
get Retrieve value for a key
|
||||||
help Help about any command
|
help Help about any command
|
||||||
import Import database dump
|
import Import database dump
|
||||||
|
info info
|
||||||
list List database contents
|
list List database contents
|
||||||
|
man show manual page
|
||||||
|
serve run REST API listener
|
||||||
set Insert key/value pair
|
set Insert key/value pair
|
||||||
|
|
||||||
Flags:
|
Flags:
|
||||||
|
-b, --bucket string use other bucket (default: data) (default "data")
|
||||||
|
-c, --config string toml config file
|
||||||
-f, --dbfile string DB file to use (default "/home/scip/.config/anydb/default.db")
|
-f, --dbfile string DB file to use (default "/home/scip/.config/anydb/default.db")
|
||||||
-d, --debug Enable debugging
|
-d, --debug Enable debugging
|
||||||
-h, --help help for anydb
|
-h, --help help for anydb
|
||||||
@@ -44,9 +34,493 @@ SYNOPSIS
|
|||||||
Use "anydb [command] --help" for more information about a command.
|
Use "anydb [command] --help" for more information about a command.
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
Anydb is a simple to use commandline tool to store anything you'd like,
|
Anydb is a commandline personal key value store, it is simple to use and
|
||||||
even binary files etc. It uses a key/value store (bbolt) in your home
|
can be used to store anything you'd like, even binary files etc. It uses
|
||||||
directory.
|
a key/value store (bbolt) in your home directory.
|
||||||
|
|
||||||
|
The tool provides a number of subcommands to use it, there are global
|
||||||
|
options and each subcommand has its own set of options.
|
||||||
|
|
||||||
|
GLOBAL OPTIONS
|
||||||
|
"-f, --dbfile filename"
|
||||||
|
The default location of your databas is
|
||||||
|
"$HOME/.config/anydb/default.db". You can change this with the "-f"
|
||||||
|
option.
|
||||||
|
|
||||||
|
"-b, --bucket name"
|
||||||
|
Data in a bbolt key-value-store are managed in so called buckets.
|
||||||
|
These are kind of namespaces, where each key must be unique.
|
||||||
|
However, a database may contain more than one bucket.
|
||||||
|
|
||||||
|
By default anydb uses a bucket named "data", but you can change this
|
||||||
|
using the option "-b".
|
||||||
|
|
||||||
|
Buckets can be configured to always encrypt values, see ENCRYTPTION.
|
||||||
|
|
||||||
|
"-c, --config filename"
|
||||||
|
Under normal circumstances you don't need a configuration file. But
|
||||||
|
if you want, you can provide one using the option "-c".
|
||||||
|
|
||||||
|
Anydb looks for a couple of default locations for a config file. You
|
||||||
|
only need this option if you want to supply a configuration on a
|
||||||
|
non-standard location. See CONFIGURATION for more details.
|
||||||
|
|
||||||
|
"-d, --debug"
|
||||||
|
Enable debug output.
|
||||||
|
|
||||||
|
"-h, --help"
|
||||||
|
Show the usage of anydb.
|
||||||
|
|
||||||
|
"-v, --version"
|
||||||
|
Show the program version.
|
||||||
|
|
||||||
|
All of these options can be used with subcommands as well.
|
||||||
|
|
||||||
|
SUBCOMMANDS
|
||||||
|
completion
|
||||||
|
The completion command can be used to setup completion for anydb. Just
|
||||||
|
put something like this into your shell's configuration file:
|
||||||
|
|
||||||
|
source <(anydb completion bash)
|
||||||
|
|
||||||
|
If you use another shell, specify it instead of bash, of course.
|
||||||
|
|
||||||
|
set
|
||||||
|
The set command is being used to insert or update a key-value pair.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb set <key> [<value> | -r <file>] [-t <tag>] [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
set, add, s, +
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-e, --encrypt encrypt value
|
||||||
|
-r, --file string Filename or - for STDIN
|
||||||
|
-h, --help help for set
|
||||||
|
-t, --tags tag,tag,... tags, multiple allowed
|
||||||
|
|
||||||
|
The standard way to insert a new entry is really simple:
|
||||||
|
|
||||||
|
anydb set key value
|
||||||
|
|
||||||
|
If you don't specify a value, anydb expects you to feed it some data via
|
||||||
|
STDIN. For example:
|
||||||
|
|
||||||
|
anydb set key < file
|
||||||
|
|
||||||
|
You might as well specify a file directly using the "-f" option:
|
||||||
|
|
||||||
|
anydb set key -f file
|
||||||
|
|
||||||
|
Values can be encrypted using ChaCha20Poly1305 when you specify the "-e"
|
||||||
|
option. Anydb will ask you interactively for a passphrase. You can also
|
||||||
|
provide the passphrase using the environment variable "ANYDB_PASSWORD".
|
||||||
|
To encrypt the value, a cryptographically secure key will be derived
|
||||||
|
from the passphrase using the ArgonID2 algorithm. Each value can be
|
||||||
|
encrypted with another passphrase. So, the database itself is not
|
||||||
|
encrypted, just the values.
|
||||||
|
|
||||||
|
You can supply tags by using the option "-t". Multiple tags can be
|
||||||
|
provided either by separating them with a comma or by using multiple
|
||||||
|
"-t" parameters:
|
||||||
|
|
||||||
|
anydb set key value -t tag1,tag2
|
||||||
|
anydb set key value -t tag1 -t tag2
|
||||||
|
|
||||||
|
You can later filter entries by tag or by a combination of tags.
|
||||||
|
|
||||||
|
To edit or modify an entry, just use the set command with the same key,
|
||||||
|
the value in the database will be overwritten with the new value. An
|
||||||
|
alternative option is the edit command, see below.
|
||||||
|
|
||||||
|
get
|
||||||
|
To retrieve the value of a key, use the get subcommand.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb get <key> [-o <file>] [-m <mode>] [-n -N] [-T <tpl>] [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
get, show, g, .
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for get
|
||||||
|
-m, --mode string output format (simple|wide|json|template) (default 'simple')
|
||||||
|
-n, --no-headers omit headers in tables
|
||||||
|
-N, --no-human do not translate to human readable values
|
||||||
|
-o, --output string output value to file (ignores -m)
|
||||||
|
-T, --template string go template for '-m template'
|
||||||
|
|
||||||
|
In its simplest form you just call the get subcommand with the key you
|
||||||
|
want to have the value for. The value is being printed to STDOUT by
|
||||||
|
default:
|
||||||
|
|
||||||
|
anydb get key
|
||||||
|
|
||||||
|
If the value is binary content, it will not just being printed. In those
|
||||||
|
cases you need to either redirect output into a file or use the option
|
||||||
|
"-o" to write to a file:
|
||||||
|
|
||||||
|
anydb get key > file
|
||||||
|
anydb get key -o file
|
||||||
|
|
||||||
|
If the value is encrypted, you will be asked for the passphrase to
|
||||||
|
decrypt it. If the environment variable "ANYDB_PASSWORD" is set, its
|
||||||
|
value will be used instead.
|
||||||
|
|
||||||
|
There are different output modes you can choose from: simple, wide and
|
||||||
|
json. The "simple" mode is the default one, it just prints the value as
|
||||||
|
is. The "wide" mode prints a tabular output similar to the list
|
||||||
|
subcommand, see there for more details. The options "-n" and "-N" have
|
||||||
|
the same meaning as in the list command. The "json" mode prints the raw
|
||||||
|
JSON representation of the whole database entry. Decryption will only
|
||||||
|
take place in "simple" and "json" mode. The "template" mode provides the
|
||||||
|
most flexibily, it is detailed in the section TEMPLATES.
|
||||||
|
|
||||||
|
list
|
||||||
|
The list subcommand displays a list of all database entries.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb list [<filter-regex> | -t <tag> ] [-m <mode>] [-nNif] [-T <tpl>] [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
list, ls, /, find, search
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-i, --case-insensitive filter case insensitive
|
||||||
|
-h, --help help for list
|
||||||
|
-m, --mode string output format (table|wide|json|template), wide is a verbose table. (default 'table')
|
||||||
|
-n, --no-headers omit headers in tables
|
||||||
|
-N, --no-human do not translate to human readable values
|
||||||
|
-s, --search-fulltext perform a full text search
|
||||||
|
-t, --tags stringArray tags, multiple allowed
|
||||||
|
-T, --template string go template for '-m template'
|
||||||
|
-l, --wide-output output mode: wide
|
||||||
|
|
||||||
|
In its simplest form - without any options - , the list command just
|
||||||
|
prints all keys with their values to STDOUT. Values are being truncated
|
||||||
|
to maximum of 60 characters, that is, multiline values are not
|
||||||
|
completely shown in order to keep the tabular view readable.
|
||||||
|
|
||||||
|
To get more informations about each entry, use the "-o wide" or "-l"
|
||||||
|
option. In addition to the key and value also the size, update timestamp
|
||||||
|
and tags will be printed. Time and size values are converted into a
|
||||||
|
human readable form, you can suppress this behavior with the "-N"
|
||||||
|
option. You may omit the headers using the option "-n"
|
||||||
|
|
||||||
|
Sometimes you might want to filter the list of entries. Either because
|
||||||
|
your database grew too large or because you're searching for something.
|
||||||
|
In that case you have two options: You may supply one or more tags or
|
||||||
|
provide a filter regexp. To filter by tag, do:
|
||||||
|
|
||||||
|
anydb list -t tag1
|
||||||
|
anydb list -t tag1,tag2
|
||||||
|
anydb list -t tag1 -t tag2
|
||||||
|
|
||||||
|
To filter using a regular expression, do:
|
||||||
|
|
||||||
|
anydb list "foo.*bar"
|
||||||
|
|
||||||
|
Regular expressions follow the golang re2 syntax. For more details about
|
||||||
|
the syntax, refer to <https://github.com/google/re2/wiki/Syntax>. Please
|
||||||
|
note, that this regexp dialect is not PCRE compatible, but supports most
|
||||||
|
of its features.
|
||||||
|
|
||||||
|
If you want to search case insensitive, add the option "-i".
|
||||||
|
|
||||||
|
By default anydb only searches through the keys. If you want to search
|
||||||
|
through the values as well, then use the "-s" option, which enables
|
||||||
|
full-text search.
|
||||||
|
|
||||||
|
You can - as with the get command - use other output modes. The default
|
||||||
|
mode is "table". The "wide" mode is, as already mentioned, a more
|
||||||
|
detailed table. Also supported is "json" mode and "template" mode. For
|
||||||
|
details about using templates see TEMPLATES.
|
||||||
|
|
||||||
|
del
|
||||||
|
Use the del command to delete database entries.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb del <key> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
del, d, rm
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for del
|
||||||
|
|
||||||
|
The subcommand del does not provide any further options, it just deletes
|
||||||
|
the entry referred to by the given key. No questions are being asked.
|
||||||
|
|
||||||
|
edit
|
||||||
|
The edit command makes it easier to modify larger entries.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb edit <key> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
edit, modify, mod, ed, vi
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for edit
|
||||||
|
|
||||||
|
The subcommand edit does not provide any further options. It works like
|
||||||
|
this:
|
||||||
|
|
||||||
|
1. Write the value info a temporary file.
|
||||||
|
2. Execute the editor (which one, see below!) with that file.
|
||||||
|
3. Now you can edit the file and save+close it when done.
|
||||||
|
4. Anydb picks up the file and if the content has changed, puts its
|
||||||
|
value into the DB.
|
||||||
|
|
||||||
|
By default anydb executes the "vi" command. You can modify this behavior
|
||||||
|
by setting the environment variable "EDITOR" appropriately.
|
||||||
|
|
||||||
|
Please note, that this does not work with binary content!
|
||||||
|
|
||||||
|
export
|
||||||
|
Since the bbolt database file is not portable across platforms (it is
|
||||||
|
bound to the endianess of the CPU it was being created on), you might
|
||||||
|
want to create a backup file of your database. You can do this with the
|
||||||
|
export subcommand.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb export -o <json filename> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
export, dump, backup
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for export
|
||||||
|
-o, --output string output to file
|
||||||
|
|
||||||
|
The database dump is a JSON representation of the whole database and
|
||||||
|
will be printed to the file specified with the "-o" option. If you
|
||||||
|
specify "-" as the filename, it will be written to STDIN.
|
||||||
|
|
||||||
|
anydb export -o dump.json
|
||||||
|
anydb export -o - > dump.json
|
||||||
|
|
||||||
|
Please note, that encrypted values will not be decrypted. This might
|
||||||
|
change in a future version of anydb.
|
||||||
|
|
||||||
|
import
|
||||||
|
The import subcommand can be used to restore a database from a JSON
|
||||||
|
dump.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb import -i <json file> [flags]
|
||||||
|
|
||||||
|
Aliases:
|
||||||
|
import, restore
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-r, --file string Filename or - for STDIN
|
||||||
|
-h, --help help for import
|
||||||
|
-t, --tags stringArray tags, multiple allowed
|
||||||
|
|
||||||
|
The "import" subcommand reads the JSON contents from the file specified
|
||||||
|
with the "-i" option. If you specify "-" as the filename, it will be
|
||||||
|
read from STDIN.
|
||||||
|
|
||||||
|
anydb import -i - < dump.json
|
||||||
|
anydb import -i dump.json
|
||||||
|
cat dump.json | anydb import -i -
|
||||||
|
|
||||||
|
If there is already a database, it will be saved by appending a
|
||||||
|
timestamp and a new database with the contents of the dump will be
|
||||||
|
created.
|
||||||
|
|
||||||
|
serve
|
||||||
|
Anydb provides a RESTful API, which you can use to manage the database
|
||||||
|
from somewhere else. The API does not provide any authentication or any
|
||||||
|
other security measures, so better only use it on localhost.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb serve [-l host:port] [flags]
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for serve
|
||||||
|
-l, --listen string host:port (default "localhost:8787")
|
||||||
|
|
||||||
|
To start the listener, just execute the serve subcommand. You can tweak
|
||||||
|
the ip address and tcp port using the "-l" option. The listener will not
|
||||||
|
fork and run in the foreground. Logs are being printed to STDOUT as long
|
||||||
|
as the listener runs.
|
||||||
|
|
||||||
|
For more details about the API, please see the "REST API" section.
|
||||||
|
|
||||||
|
info
|
||||||
|
The info subcommand shows you some information about your current
|
||||||
|
database.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb info [flags]
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for info
|
||||||
|
-N, --no-human do not translate to human readable values
|
||||||
|
|
||||||
|
Data being shown are: filename and size, number of keys per bucket. If
|
||||||
|
you supply the "-d" option (debug), some bbolt internals are being
|
||||||
|
displayed as well.
|
||||||
|
|
||||||
|
man
|
||||||
|
The man subcommand shows an unformatted text variant of the manual page
|
||||||
|
(which are currently reading).
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
anydb man [flags]
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for man
|
||||||
|
|
||||||
|
The manual is being piped into the "more" command, which is being
|
||||||
|
expected to exist according to the POSIX standard on all supported unix
|
||||||
|
platforms. It might not work on Windows.
|
||||||
|
|
||||||
|
TEMPLATES
|
||||||
|
The get and list commands support a template feature, which is very
|
||||||
|
handy to create you own kind of formatting. The template syntax being
|
||||||
|
used is the GO template language, refer to
|
||||||
|
<https://pkg.go.dev/text/template> for details.
|
||||||
|
|
||||||
|
Each template operates on one or more entries, no loop construct is
|
||||||
|
required, the template provided applies to every matching entry
|
||||||
|
separatley.
|
||||||
|
|
||||||
|
The following template variables can be used:
|
||||||
|
|
||||||
|
Key - string
|
||||||
|
Value - string
|
||||||
|
Bin - []byte
|
||||||
|
Created - time.Time
|
||||||
|
Tags - []string
|
||||||
|
Encrypted bool
|
||||||
|
|
||||||
|
Prepend a single dot (".") before each variable name.
|
||||||
|
|
||||||
|
Here are some examples how to use the feature:
|
||||||
|
|
||||||
|
Only show the keys of all entries:
|
||||||
|
|
||||||
|
anydb list -m template -T "{{ .Key }}"
|
||||||
|
|
||||||
|
Format the list in a way so that is possible to evaluate it in a shell:
|
||||||
|
|
||||||
|
eval $(anydb get foo -m template -T "key='{{ .Key }}' value='{{ .Value }}' ts='{{ .Created}}'")
|
||||||
|
echo "Key: $key, Value: $value"
|
||||||
|
|
||||||
|
Print the values in CSV format ONLY if they have some tag:
|
||||||
|
|
||||||
|
anydb list -m template -T "{{ if .Tags }}{{ .Key }},{{ .Value }},{{ .Created}}{{ end }}"
|
||||||
|
|
||||||
|
CONFIGURATION
|
||||||
|
Anydb looks at the following locations for a configuration file, in that
|
||||||
|
order:
|
||||||
|
|
||||||
|
"$HOME/.config/anydb/anydb.toml"
|
||||||
|
"$HOME/.anydb.toml"
|
||||||
|
"anydb.toml" in the current directory
|
||||||
|
or specify one using "-c"
|
||||||
|
|
||||||
|
The configuration format uses the TOML language, refer to
|
||||||
|
<https://toml.io/en/> for more details. The key names correspond to the
|
||||||
|
commandline options in most cases.
|
||||||
|
|
||||||
|
Configuration follows a certain precedence: the files are tried to be
|
||||||
|
read in the given order, followed by commandline options. That is, the
|
||||||
|
last configuration file wins, unless the user provides a commandline
|
||||||
|
option, then this setting will be taken.
|
||||||
|
|
||||||
|
A complete configuration file might look like this:
|
||||||
|
|
||||||
|
# defaults
|
||||||
|
dbfile = "~/.config/anydb/default.db"
|
||||||
|
dbbucket = "data"
|
||||||
|
noheaders = false
|
||||||
|
nohumanize = false
|
||||||
|
encrypt = false
|
||||||
|
listen = "localhost:8787"
|
||||||
|
|
||||||
|
# different setups for different buckets
|
||||||
|
[buckets.data]
|
||||||
|
encrypt = true
|
||||||
|
|
||||||
|
[buckets.test]
|
||||||
|
encrypt = false
|
||||||
|
|
||||||
|
Under normal circumstances you don't need a configuration file. However,
|
||||||
|
if you want to use different buckets, then this might be a handy option.
|
||||||
|
Buckets are being configured in ini-style with the term "bucket."
|
||||||
|
followed by the bucket name. In the example above we enable encryption
|
||||||
|
for the default bucket "data" and disable it for a bucket "test". To use
|
||||||
|
different buckets, use the "-b" option.
|
||||||
|
|
||||||
|
REST API
|
||||||
|
The subcommand serve starts a simple HTTP service, which responds to
|
||||||
|
RESTful HTTP requests. The listener responds to all requests with a JSON
|
||||||
|
encoded response. The response contains the status and the content - if
|
||||||
|
any - of the requested resource.
|
||||||
|
|
||||||
|
The following requests are supported:
|
||||||
|
|
||||||
|
GET /anydb/v1/
|
||||||
|
Returns a JSON encoded list of all entries.
|
||||||
|
|
||||||
|
GET /anydb/v1/key
|
||||||
|
Returns the JSON encoded entry, if found.
|
||||||
|
|
||||||
|
PUT /anydb/v1/
|
||||||
|
Create an entry. Expects a JSON encoded request object in POST data.
|
||||||
|
|
||||||
|
DELETE /anydb/v1/key
|
||||||
|
Delete an entry.
|
||||||
|
|
||||||
|
Some curl example calls to the API:
|
||||||
|
|
||||||
|
Post a new key: curl -X PUT localhost:8787/anydb/v1/ \ -H 'Content-Type:
|
||||||
|
application/json' \ -d '{"key":"foo","val":"bar"}'
|
||||||
|
|
||||||
|
Retrieve the value:
|
||||||
|
|
||||||
|
curl localhost:8787/anydb/v1/foo
|
||||||
|
|
||||||
|
List all keys:
|
||||||
|
|
||||||
|
curl localhost:8787/anydb/v1/
|
||||||
|
|
||||||
|
BUGS
|
||||||
|
In order to report a bug, unexpected behavior, feature requests or to
|
||||||
|
submit a patch, please open an issue on github:
|
||||||
|
<https://github.com/TLINDEN/anydb/issues>.
|
||||||
|
|
||||||
|
Please repeat the failing command with debugging enabled "-d" and
|
||||||
|
include the output in the issue.
|
||||||
|
|
||||||
|
LIMITATIONS
|
||||||
|
The REST API list request doesn't provide any filtering capabilities
|
||||||
|
yet.
|
||||||
|
|
||||||
LICENSE
|
LICENSE
|
||||||
This software is licensed under the GNU GENERAL PUBLIC LICENSE version
|
This software is licensed under the GNU GENERAL PUBLIC LICENSE version
|
||||||
|
|||||||
28
cmd/crud.go
28
cmd/crud.go
@@ -20,7 +20,6 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
"unicode/utf8"
|
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
"github.com/tlinden/anydb/app"
|
"github.com/tlinden/anydb/app"
|
||||||
@@ -124,12 +123,7 @@ func Get(conf *cfg.Config) *cobra.Command {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if utf8.ValidString(string(clear)) {
|
entry.Value = clear
|
||||||
entry.Value = string(clear)
|
|
||||||
} else {
|
|
||||||
entry.Bin = clear
|
|
||||||
}
|
|
||||||
|
|
||||||
entry.Encrypted = false
|
entry.Encrypted = false
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -138,7 +132,7 @@ func Get(conf *cfg.Config) *cobra.Command {
|
|||||||
}
|
}
|
||||||
|
|
||||||
cmd.PersistentFlags().StringVarP(&attr.File, "output", "o", "", "output value to file (ignores -m)")
|
cmd.PersistentFlags().StringVarP(&attr.File, "output", "o", "", "output value to file (ignores -m)")
|
||||||
cmd.PersistentFlags().StringVarP(&conf.Mode, "mode", "m", "", "output format (simple|wide|json) (default 'simple')")
|
cmd.PersistentFlags().StringVarP(&conf.Mode, "mode", "m", "", "output format (simple|wide|json|template) (default 'simple')")
|
||||||
cmd.PersistentFlags().BoolVarP(&conf.NoHeaders, "no-headers", "n", false, "omit headers in tables")
|
cmd.PersistentFlags().BoolVarP(&conf.NoHeaders, "no-headers", "n", false, "omit headers in tables")
|
||||||
cmd.PersistentFlags().BoolVarP(&conf.NoHumanize, "no-human", "N", false, "do not translate to human readable values")
|
cmd.PersistentFlags().BoolVarP(&conf.NoHumanize, "no-human", "N", false, "do not translate to human readable values")
|
||||||
cmd.PersistentFlags().StringVarP(&conf.Template, "template", "T", "", "go template for '-m template'")
|
cmd.PersistentFlags().StringVarP(&conf.Template, "template", "T", "", "go template for '-m template'")
|
||||||
@@ -188,7 +182,7 @@ func List(conf *cfg.Config) *cobra.Command {
|
|||||||
)
|
)
|
||||||
|
|
||||||
var cmd = &cobra.Command{
|
var cmd = &cobra.Command{
|
||||||
Use: "list [<filter-regex>] [-t <tag>] [-m <mode>] [-n -N] [-T <tpl>]",
|
Use: "list [<filter-regex> | -t <tag> ] [-m <mode>] [-nNif] [-T <tpl>]",
|
||||||
Short: "List database contents",
|
Short: "List database contents",
|
||||||
Long: `List database contents`,
|
Long: `List database contents`,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
@@ -196,7 +190,11 @@ func List(conf *cfg.Config) *cobra.Command {
|
|||||||
cmd.SilenceUsage = true
|
cmd.SilenceUsage = true
|
||||||
|
|
||||||
if len(args) > 0 {
|
if len(args) > 0 {
|
||||||
attr.Args = args
|
if conf.CaseInsensitive {
|
||||||
|
attr.Args = []string{"(?i)" + args[0]}
|
||||||
|
} else {
|
||||||
|
attr.Args = args
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// turn comma list into slice, if needed
|
// turn comma list into slice, if needed
|
||||||
@@ -208,7 +206,7 @@ func List(conf *cfg.Config) *cobra.Command {
|
|||||||
conf.Mode = "wide"
|
conf.Mode = "wide"
|
||||||
}
|
}
|
||||||
|
|
||||||
entries, err := conf.DB.List(&attr)
|
entries, err := conf.DB.List(&attr, conf.Fulltext)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -217,15 +215,19 @@ func List(conf *cfg.Config) *cobra.Command {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.PersistentFlags().StringVarP(&conf.Mode, "mode", "m", "", "output format (table|wide|json), wide is a verbose table. (default 'table')")
|
cmd.PersistentFlags().StringVarP(&conf.Mode, "mode", "m", "", "output format (table|wide|json|template), wide is a verbose table. (default 'table')")
|
||||||
cmd.PersistentFlags().StringVarP(&conf.Template, "template", "T", "", "go template for '-m template'")
|
cmd.PersistentFlags().StringVarP(&conf.Template, "template", "T", "", "go template for '-m template'")
|
||||||
cmd.PersistentFlags().BoolVarP(&wide, "wide-output", "l", false, "output mode: wide")
|
cmd.PersistentFlags().BoolVarP(&wide, "wide-output", "l", false, "output mode: wide")
|
||||||
cmd.PersistentFlags().BoolVarP(&conf.NoHeaders, "no-headers", "n", false, "omit headers in tables")
|
cmd.PersistentFlags().BoolVarP(&conf.NoHeaders, "no-headers", "n", false, "omit headers in tables")
|
||||||
cmd.PersistentFlags().BoolVarP(&conf.NoHumanize, "no-human", "N", false, "do not translate to human readable values")
|
cmd.PersistentFlags().BoolVarP(&conf.NoHumanize, "no-human", "N", false, "do not translate to human readable values")
|
||||||
|
cmd.PersistentFlags().BoolVarP(&conf.CaseInsensitive, "case-insensitive", "i", false, "filter case insensitive")
|
||||||
|
cmd.PersistentFlags().BoolVarP(&conf.Fulltext, "search-fulltext", "s", false, "perform a full text search")
|
||||||
cmd.PersistentFlags().StringArrayVarP(&attr.Tags, "tags", "t", nil, "tags, multiple allowed")
|
cmd.PersistentFlags().StringArrayVarP(&attr.Tags, "tags", "t", nil, "tags, multiple allowed")
|
||||||
|
|
||||||
cmd.Aliases = append(cmd.Aliases, "/")
|
|
||||||
cmd.Aliases = append(cmd.Aliases, "ls")
|
cmd.Aliases = append(cmd.Aliases, "ls")
|
||||||
|
cmd.Aliases = append(cmd.Aliases, "/")
|
||||||
|
cmd.Aliases = append(cmd.Aliases, "find")
|
||||||
|
cmd.Aliases = append(cmd.Aliases, "search")
|
||||||
|
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|||||||
34
cmd/extra.go
34
cmd/extra.go
@@ -23,7 +23,6 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"unicode/utf8"
|
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
"github.com/tlinden/anydb/app"
|
"github.com/tlinden/anydb/app"
|
||||||
@@ -38,16 +37,16 @@ func Export(conf *cfg.Config) *cobra.Command {
|
|||||||
)
|
)
|
||||||
|
|
||||||
var cmd = &cobra.Command{
|
var cmd = &cobra.Command{
|
||||||
Use: "export [-o <json filename>]",
|
Use: "export -o <json filename>",
|
||||||
Short: "Export database to json",
|
Short: "Export database to json file",
|
||||||
Long: `Export database to json`,
|
Long: `Export database to json file`,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
// errors at this stage do not cause the usage to be shown
|
// errors at this stage do not cause the usage to be shown
|
||||||
cmd.SilenceUsage = true
|
cmd.SilenceUsage = true
|
||||||
|
|
||||||
conf.Mode = "json"
|
conf.Mode = "json"
|
||||||
|
|
||||||
entries, err := conf.DB.List(&attr)
|
entries, err := conf.DB.Getall(&attr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -56,7 +55,10 @@ func Export(conf *cfg.Config) *cobra.Command {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.PersistentFlags().StringVarP(&attr.File, "output", "o", "", "output to file")
|
cmd.PersistentFlags().StringVarP(&attr.File, "output-file", "o", "", "filename or - for STDIN")
|
||||||
|
if err := cmd.MarkPersistentFlagRequired("output-file"); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
cmd.Aliases = append(cmd.Aliases, "dump")
|
cmd.Aliases = append(cmd.Aliases, "dump")
|
||||||
cmd.Aliases = append(cmd.Aliases, "backup")
|
cmd.Aliases = append(cmd.Aliases, "backup")
|
||||||
@@ -70,7 +72,7 @@ func Import(conf *cfg.Config) *cobra.Command {
|
|||||||
)
|
)
|
||||||
|
|
||||||
var cmd = &cobra.Command{
|
var cmd = &cobra.Command{
|
||||||
Use: "import [<json file>]",
|
Use: "import -i <json file>",
|
||||||
Short: "Import database dump",
|
Short: "Import database dump",
|
||||||
Long: `Import database dump`,
|
Long: `Import database dump`,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
@@ -87,8 +89,11 @@ func Import(conf *cfg.Config) *cobra.Command {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.PersistentFlags().StringVarP(&attr.File, "file", "r", "", "Filename or - for STDIN")
|
cmd.PersistentFlags().StringVarP(&attr.File, "import-file", "i", "", "filename or - for STDIN")
|
||||||
cmd.PersistentFlags().StringArrayVarP(&attr.Tags, "tags", "t", nil, "tags, multiple allowed")
|
cmd.PersistentFlags().StringArrayVarP(&attr.Tags, "tags", "t", nil, "tags, multiple allowed")
|
||||||
|
if err := cmd.MarkPersistentFlagRequired("import-file"); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
cmd.Aliases = append(cmd.Aliases, "restore")
|
cmd.Aliases = append(cmd.Aliases, "restore")
|
||||||
|
|
||||||
@@ -199,7 +204,7 @@ func Edit(conf *cfg.Config) *cobra.Command {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(entry.Value) == 0 && len(entry.Bin) > 0 {
|
if len(entry.Value) == 0 && entry.Binary {
|
||||||
return errors.New("key contains binary uneditable content")
|
return errors.New("key contains binary uneditable content")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -216,12 +221,7 @@ func Edit(conf *cfg.Config) *cobra.Command {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if utf8.ValidString(string(clear)) {
|
entry.Value = clear
|
||||||
entry.Value = string(clear)
|
|
||||||
} else {
|
|
||||||
entry.Bin = clear
|
|
||||||
}
|
|
||||||
|
|
||||||
entry.Encrypted = false
|
entry.Encrypted = false
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -231,7 +231,7 @@ func Edit(conf *cfg.Config) *cobra.Command {
|
|||||||
// save file to a temp file, call the editor with it, read
|
// save file to a temp file, call the editor with it, read
|
||||||
// it back in and compare the content with the original
|
// it back in and compare the content with the original
|
||||||
// one
|
// one
|
||||||
newcontent, err := editContent(editor, entry.Value)
|
newcontent, err := editContent(editor, string(entry.Value))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -241,7 +241,7 @@ func Edit(conf *cfg.Config) *cobra.Command {
|
|||||||
Key: attr.Key,
|
Key: attr.Key,
|
||||||
Tags: attr.Tags,
|
Tags: attr.Tags,
|
||||||
Encrypted: attr.Encrypted,
|
Encrypted: attr.Encrypted,
|
||||||
Val: newcontent,
|
Val: []byte(newcontent),
|
||||||
}
|
}
|
||||||
|
|
||||||
// encrypt if needed
|
// encrypt if needed
|
||||||
|
|||||||
1
go.mod
1
go.mod
@@ -29,4 +29,5 @@ require (
|
|||||||
golang.org/x/sys v0.28.0 // indirect
|
golang.org/x/sys v0.28.0 // indirect
|
||||||
golang.org/x/term v0.27.0 // indirect
|
golang.org/x/term v0.27.0 // indirect
|
||||||
golang.org/x/tools v0.22.0 // indirect
|
golang.org/x/tools v0.22.0 // indirect
|
||||||
|
google.golang.org/protobuf v1.36.1 // indirect
|
||||||
)
|
)
|
||||||
|
|||||||
2
go.sum
2
go.sum
@@ -89,6 +89,8 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm
|
|||||||
golang.org/x/tools v0.22.0 h1:gqSGLZqv+AI9lIQzniJ0nZDRG5GBPsSi+DRNHWNz6yA=
|
golang.org/x/tools v0.22.0 h1:gqSGLZqv+AI9lIQzniJ0nZDRG5GBPsSi+DRNHWNz6yA=
|
||||||
golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c=
|
golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c=
|
||||||
google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
|
google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
|
||||||
|
google.golang.org/protobuf v1.36.1 h1:yBPeRvTftaleIgM3PZ/WBIZ7XM/eEYAaEyCwvyjq/gk=
|
||||||
|
google.golang.org/protobuf v1.36.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
|
|||||||
@@ -65,8 +65,6 @@ func ListTemplate(writer io.Writer, conf *cfg.Config, entries app.DbEntries) err
|
|||||||
buf := bytes.Buffer{}
|
buf := bytes.Buffer{}
|
||||||
|
|
||||||
for _, row := range entries {
|
for _, row := range entries {
|
||||||
row.Normalize()
|
|
||||||
|
|
||||||
buf.Reset()
|
buf.Reset()
|
||||||
err = tmpl.Execute(&buf, row)
|
err = tmpl.Execute(&buf, row)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -94,31 +92,28 @@ func ListTable(writer io.Writer, conf *cfg.Config, entries app.DbEntries) error
|
|||||||
}
|
}
|
||||||
|
|
||||||
for _, row := range entries {
|
for _, row := range entries {
|
||||||
row.Normalize()
|
|
||||||
|
|
||||||
if conf.Mode == "wide" {
|
if conf.Mode == "wide" {
|
||||||
switch conf.NoHumanize {
|
switch conf.NoHumanize {
|
||||||
case true:
|
case true:
|
||||||
table.Append([]string{
|
table.Append([]string{
|
||||||
row.Key,
|
row.Key,
|
||||||
strings.Join(row.Tags, ","),
|
strings.Join(row.Tags, ","),
|
||||||
strconv.Itoa(row.Size),
|
strconv.FormatUint(row.Size, 10),
|
||||||
row.Created.Format("02.01.2006T03:04.05"),
|
row.Created.AsTime().Format("02.01.2006T03:04.05"),
|
||||||
row.Value,
|
row.Preview,
|
||||||
})
|
})
|
||||||
default:
|
default:
|
||||||
table.Append([]string{
|
table.Append([]string{
|
||||||
row.Key,
|
row.Key,
|
||||||
strings.Join(row.Tags, ","),
|
strings.Join(row.Tags, ","),
|
||||||
humanize.Bytes(uint64(row.Size)),
|
humanize.Bytes(uint64(row.Size)),
|
||||||
//row.Created.Format("02.01.2006T03:04.05"),
|
humanize.Time(row.Created.AsTime()),
|
||||||
humanize.Time(row.Created),
|
row.Preview,
|
||||||
row.Value,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
} else {
|
} else {
|
||||||
table.Append([]string{row.Key, row.Value})
|
table.Append([]string{row.Key, row.Preview})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,6 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"reflect"
|
"reflect"
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/dustin/go-humanize"
|
"github.com/dustin/go-humanize"
|
||||||
"github.com/tlinden/anydb/app"
|
"github.com/tlinden/anydb/app"
|
||||||
@@ -40,16 +39,15 @@ func Print(writer io.Writer, conf *cfg.Config, attr *app.DbAttr, entry *app.DbEn
|
|||||||
|
|
||||||
switch conf.Mode {
|
switch conf.Mode {
|
||||||
case "simple", "":
|
case "simple", "":
|
||||||
if len(entry.Bin) > 0 {
|
if entry.Binary {
|
||||||
if isatty {
|
if isatty {
|
||||||
fmt.Println("binary data omitted")
|
fmt.Println("binary data omitted")
|
||||||
} else {
|
} else {
|
||||||
os.Stdout.Write(entry.Bin)
|
os.Stdout.Write(entry.Value)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
fmt.Print(entry.Value)
|
fmt.Print(string(entry.Value))
|
||||||
|
if entry.Value[entry.Size-1] != '\n' {
|
||||||
if !strings.HasSuffix(entry.Value, "\n") {
|
|
||||||
// always add a terminal newline
|
// always add a terminal newline
|
||||||
fmt.Println()
|
fmt.Println()
|
||||||
}
|
}
|
||||||
@@ -62,9 +60,9 @@ func Print(writer io.Writer, conf *cfg.Config, attr *app.DbAttr, entry *app.DbEn
|
|||||||
|
|
||||||
fmt.Println(string(jsonentry))
|
fmt.Println(string(jsonentry))
|
||||||
case "wide":
|
case "wide":
|
||||||
return ListTable(writer, conf, app.DbEntries{*entry})
|
return ListTable(writer, conf, app.DbEntries{entry})
|
||||||
case "template":
|
case "template":
|
||||||
return ListTemplate(writer, conf, app.DbEntries{*entry})
|
return ListTemplate(writer, conf, app.DbEntries{entry})
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -77,7 +75,6 @@ func WriteFile(writer io.Writer, conf *cfg.Config, attr *app.DbAttr, entry *app.
|
|||||||
if attr.File == "-" {
|
if attr.File == "-" {
|
||||||
fileHandle = os.Stdout
|
fileHandle = os.Stdout
|
||||||
} else {
|
} else {
|
||||||
|
|
||||||
fd, err := os.OpenFile(attr.File, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0755)
|
fd, err := os.OpenFile(attr.File, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0755)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to open file %s for writing: %w", attr.File, err)
|
return fmt.Errorf("failed to open file %s for writing: %w", attr.File, err)
|
||||||
@@ -87,17 +84,14 @@ func WriteFile(writer io.Writer, conf *cfg.Config, attr *app.DbAttr, entry *app.
|
|||||||
fileHandle = fd
|
fileHandle = fd
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(entry.Bin) > 0 {
|
// actually write file content
|
||||||
// binary file content
|
_, err = fileHandle.Write(entry.Value)
|
||||||
_, err = fileHandle.Write(entry.Bin)
|
|
||||||
} else {
|
|
||||||
val := entry.Value
|
|
||||||
if !strings.HasSuffix(val, "\n") {
|
|
||||||
// always add a terminal newline
|
|
||||||
val += "\n"
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = fileHandle.Write([]byte(val))
|
if !entry.Binary {
|
||||||
|
if entry.Value[entry.Size-1] != '\n' {
|
||||||
|
// always add a terminal newline
|
||||||
|
_, err = fileHandle.Write([]byte{'\n'})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ func RestList(c *fiber.Ctx, conf *cfg.Config) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// get list
|
// get list
|
||||||
entries, err := conf.DB.List(attr)
|
entries, err := conf.DB.List(attr, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return JsonStatus(c, fiber.StatusForbidden,
|
return JsonStatus(c, fiber.StatusForbidden,
|
||||||
"Unable to list keys: "+err.Error())
|
"Unable to list keys: "+err.Error())
|
||||||
|
|||||||
@@ -32,3 +32,20 @@ stdout 50
|
|||||||
# look if it's inside the db
|
# look if it's inside the db
|
||||||
exec anydb -f test.db ls
|
exec anydb -f test.db ls
|
||||||
stdout datum.*binary-content
|
stdout datum.*binary-content
|
||||||
|
|
||||||
|
# do the same thing with text content, start with a new text entry
|
||||||
|
exec anydb -f test.db set feed alpha
|
||||||
|
|
||||||
|
# which we write to a file
|
||||||
|
exec anydb -f test.db get feed -o out2.txt
|
||||||
|
exists out2.txt
|
||||||
|
|
||||||
|
# check if its filled (5 bytes + newline)
|
||||||
|
exec ls -l out2.txt
|
||||||
|
stdout 6
|
||||||
|
|
||||||
|
# compare content
|
||||||
|
exec cat out2.txt
|
||||||
|
stdout alpha
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -23,10 +23,10 @@ exec anydb -f test.db export -o backup.json
|
|||||||
stdout 'database contents exported to backup.json'
|
stdout 'database contents exported to backup.json'
|
||||||
|
|
||||||
# import into new db
|
# import into new db
|
||||||
exec anydb -f new.db import -r backup.json
|
exec anydb -f new.db import -i backup.json
|
||||||
stdout 'imported.*entries'
|
stdout 'imported.*entries'
|
||||||
|
|
||||||
# check contents
|
# check contents
|
||||||
exec anydb -f new.db list
|
exec anydb -f new.db list bar -s
|
||||||
stdout foo.*bar
|
stdout foo.*bar
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,9 @@
|
|||||||
# simple entry
|
# simple entry
|
||||||
exec anydb -f test.db set foo bar
|
exec anydb -f test.db set foo bar
|
||||||
|
|
||||||
|
# single entry uc()
|
||||||
|
exec anydb -f test.db set MUCHAS gracias
|
||||||
|
|
||||||
# entry with tags
|
# entry with tags
|
||||||
exec anydb -f test.db set color grey -t flower,plant
|
exec anydb -f test.db set color grey -t flower,plant
|
||||||
|
|
||||||
@@ -34,9 +37,13 @@ exec anydb -f test.db list -t flower
|
|||||||
! stdout bar
|
! stdout bar
|
||||||
|
|
||||||
# list with filter
|
# list with filter
|
||||||
exec anydb -f test.db list b.r
|
exec anydb -f test.db list b.r -s
|
||||||
stdout bar
|
stdout bar
|
||||||
|
|
||||||
|
# list with -i filter
|
||||||
|
exec anydb -f test.db list -is mucha
|
||||||
|
stdout mucha
|
||||||
|
|
||||||
# get single entry
|
# get single entry
|
||||||
exec anydb -f test.db get color
|
exec anydb -f test.db get color
|
||||||
stdout grey
|
stdout grey
|
||||||
|
|||||||
Reference in New Issue
Block a user