Skip to content

Commit

Permalink
doc: choose info needed
Browse files Browse the repository at this point in the history
Changed compilation options to get smaller binaries
  • Loading branch information
Sxmourai committed Mar 9, 2024
1 parent c101091 commit f8f8231
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .cargo/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[target.'*']
rustflags = ["-Ctarget-cpu=native"]
5 changes: 5 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,9 @@ rust-fuzzy-search = "0.1.1"
[profile.dev.package."*"]
opt-level = 3

[profile.release]
opt-level = "s"
overflow-checks = false
strip = true

#todo addd color_eyre
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Keepass is a great tool that I use day to day, but sometimes I don't want to open my whole vault just to get one password.
So this tool will try to be fast and secure to give you your passwords !
This tool is written in Rust, it's ~2Mb in release mode.
Opening the databases can be slow (~1 second), which is a problem, but I can't do anything to fix that

# Usage
The config (database path & key) can be set using a cli argument, so I recommend setting up an alias like:
Expand All @@ -14,7 +16,14 @@ If you don't set the password via cli args, it will be asked in an input
Let's say we have a db `Example.kdbx` with the password 1234 (in the project's root)
We have an entry named something like youtube, then we can find it using:
```sh
fcpass ./Example.kdbx read Youtube
$ fcpass ./Example.kdbx read Youtube
Database key: *1234* (not showed when typing)
1221
```
Or you can choose the info you want:
```sh
$ fcpass ./Example.kdbx read Youtube password # default behaviour
$ fcpass ./Example.kdbx read Youtube username # username in entry
$ fcpass ./Example.kdbx read Youtube title # title of entry
$ fcpass ./Example.kdbx read Youtube infos # all of the above
```

0 comments on commit f8f8231

Please sign in to comment.