Skip to content

Vault-Term is a productivity software to manage projects in the terminal in a more comfy way. In Vault-Term you can create and manage your projects from the terminal, it is oriented towards productivity and note taking, but you can also write code with it.

License

Notifications You must be signed in to change notification settings

AgustinDoCanto/Vault-Term

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vault-Term

Vault-Term-Logo


About Vault-Term

Vault-Term is a terminal-based productivity tool designed to help you manage projects in a more efficient and comfortable way.

With Vault-Term, you can create and manage projects directly from the terminal. While it is primarily oriented toward productivity and note-taking, you can also use it to write code.

Inspired by the Obsidian philosophy, Vault-Term is an open-source project—contributions are welcome! :)


Dependencies

Vault-Term is built with Python 3.12.5 and relies on the following dependencies:

Vault-Term uses Figlet to generate ASCII art, particularly for the Vault-Term logo. More details can be found in the Figlet repository.

Vault-Term utilizes Tabulate to create structured and readable ASCII tables within the terminal. More information is available on the Tabulate PyPI page.

Vault-Term uses Inquirer to streamline navigation within its menu system. You can learn more about it on the Inquirer PyPI page.

Vault-Term integrates Vim as the default text editor for managing project files. You can install it by following the instructions in the Vim documentation.


Installation

Vault-Term was developed on Arch Linux, but it should work on any UNIX-based system, including macOS and Ubuntu.

Prerequisites: Python and Figlet

Installing Figlet

Vault-Term requires Figlet for ASCII art generation. Install it using the following commands:

Arch Linux:

sudo pacman -Syu figlet

Ubuntu:

sudo apt install figlet

Installing Python

Ensure that Python 3 is installed on your system:

Arch Linux:

sudo pacman -Syu python3

Ubuntu:

sudo apt install python3

Installing Vault-Term

Once the prerequisites are installed, follow these steps to set up Vault-Term:

  1. Clone the repository:
git clone https://github.com/AgustinDoCanto/Vault-Term.git
  1. Navigate to the Vault-Term directory:
cd Vault-Term
  1. Run the installation script:
./install.sh

This script sets up a Python virtual environment and installs the required dependencies (Inquirer and Tabulate).


Running Vault-Term

Once installed, launch Vault-Term by running:

./Vault.sh

This script activates the virtual environment and executes vault.py, the main script that powers Vault-Term. Enjoy!

About

Vault-Term is a productivity software to manage projects in the terminal in a more comfy way. In Vault-Term you can create and manage your projects from the terminal, it is oriented towards productivity and note taking, but you can also write code with it.

Resources

License

Stars

Watchers

Forks

Packages

No packages published