celediel/agedit
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update readme

Browse source
This commit is contained in:
Lilian Jónsdóttir 2024-03-11 17:41:39 -07:00
parent 746899a2c3
commit 91c947b930
1 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -3,20 +3,33 @@
open an age encrypted file in $EDITOR
## cli
`go install git.burning.moe/celediel/agedit@latest`
`go install git.burning.moe/celediel/agedit/cmd/agedit@latest`
`agedit [flags] filename`
### flags
``` --identity value, -i value age identity file to use
--out value, -o value Write to this file instead of the input file
```text
--identity value, -i value age identity file to use
--out value, -o value write to this file instead of the input file
--log value, -l value log level (default: "warn")
--editor value, -e value specify the editor to use
--help, -h show help
--version, -v print the version
```
## library
`go get git.burning.moe/celediel/agedit@latest`
<!-- TODO: figure out how to get this in one package/get/import whatever -->
for environmental variable loading:
`go get git.burning.moe/celediel/agedit/pkg/env@latest`
for opening files with editor:
`go get git.burning.moe/celediel/agedit/pkg/editor@latest`
for encrypting files:
`go get git.burning.moe/celediel/agedit/pkg/encrypt@latest`
for generating temporary filenames:
`go get git.burning.moe/celediel/agedit/pkg/tmpfile@latest`
See `./cmd/agedit/agedit.go` for example usage.