TermKeyVault 0.1.2

dotnet tool install --global TermKeyVault --version 0.1.2
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local TermKeyVault --version 0.1.2
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=TermKeyVault&version=0.1.2
nuke :add-package TermKeyVault --version 0.1.2

TermKeyVault

Terminal password manager

Warning ⚠️

TermKeyValut is still in development and is not ready for use. Do not have high expectations for this project.

Description 📝

TermKeyValut is my side project to explore Functional Programming, F# and how it works with Terminal.Gui. The idea is to create a password manager that is easy to use and can be used in the terminal. It is by no means secure (although it uses encrypted SQLite database and uses basic encryption) and if your main goal is to have a secure password manager, I would recommend using KeePass, from which I drew inspiration while developing this application.

Screenshots 📷

Login window Main menu Password generator

Installation 📦

To install whale you need to have the following dependencies installed on your system:

Once you have the dependencies installed, you can download TermKeyVault using this command:

dotnet tool install --global TermKeyVault

TermKeyVault is constantly being developed, so to update it to the latest version, use the following command:

dotnet tool update --global TermKeyVault

Usage 🧑‍💻

To use TermKeyVault type tkv in terminal. You will be prompted to enter your master password. If you are using TermKeyVault for the first time, you will be asked to create a new database. After that you will be presented with the main menu.

TechStack 📚

Development 🛠️

To get started clone the repository:

git clone https://github.com/MaciekWin3/TermKeyVault

And you are ready to go! Just bare in mind that if you are using TermKeyVault as a password manager, your development setup will conflict with your production setup. Also I recommend using DB Browser for SQLite to access encrytpted SQLite database.

Notes 📒

This project was written with the purpose of exploring the F# language and how it interacts with the Terminal.Gui library. My experience has shown that initially, this combination is well-suited for building a simple prototype. However, when it comes to developing more complex applications where two components are interdependent, I'd prefer to use C#. Since this was my first major project in F#, the code quality could have been better, so I encourage contributions.

Contributing 🤝

If you want to contribute to this project, feel free to do so. I am open to any suggestions and improvements.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
0.1.2 184 11/21/2023
0.1.1 175 11/10/2023
0.1.0 179 11/9/2023