Terminality

Terminality is a versatile tool for customizing and enhancing your command line experience on Windows. It provides a dynamic and customizable console prompt generator, allowing you to personalize your command line interface with ease.

Table of Contents

• Project Overview
• Key Features
• Inspiration
• Getting Started
  • Prerequisites
  • Installation
• Usage
• FAQ
• Credits
• Disclaimer
• How to Contribute
• Reporting Issues
• License

Project Overview

Terminality is designed to empower Windows users with a customizable console prompt that includes user, host, directory, and Git branch information. It aims to enhance productivity and streamline the command line experience for developers and system administrators.

Inspiration

Terminality draws inspiration from tools like OhMyPosh, which enhance the command line experience by providing customizable prompts and additional features. By building upon the ideas and concepts introduced by such projects, Terminality aims to offer a similar level of flexibility and functionality tailored specifically for Windows users.

Key Features

• Dynamic Prompt Generation: Terminality generates a customized console prompt that adapts to your system environment and Git repository status.
• Git Integration: The prompt includes information about the current Git branch, providing valuable context for version-controlled projects.
• Virtual Environment Indicator: Terminality detects and displays information about Python virtual environments, making it easy to manage Python projects.

Getting Started

Prerequisites

To use Terminality, you'll need:

• Windows operating system
• Python 3.x (Check python.org for the latest version)

Installation

Manual Installation

1. Clone the Repository:

   git clone https://github.com/VermiNew/Terminality.git
   

2. Install Dependencies: Navigate to the root directory of the repository and run:

   pip install -r requirements.txt
   

Automated Installation

If you're using Windows, Terminality offers a hassle-free installation process with its install.bat script. This script automates the setup by handling environment preparation and package installation. Here's how to get started:

1. Clone the Repository: First, clone the Terminality repository to your local machine by running the following command in your command prompt:

   git clone https://github.com/VermiNew/Terminality.git
   

2. Navigate to the Repository Directory: Open a command prompt and navigate to the directory where you cloned Terminality:

   cd Terminality
   

3. Run the Installation Script: Execute the install.bat script to set up Terminality. Simply type the following command in your command prompt:

   .\install.bat
   

   This script will take care of all the setup tasks, ensuring that Terminality is ready to use with minimal effort.

Usage

Using Terminality is straightforward. Once it's installed, you can launch it by executing the term.bat script provided in the repository. This will open a command prompt with the customized console prompt generated by Terminality.

By following these simple steps, you'll be up and running with Terminality in no time, ready to enhance your command line experience on Windows.

FAQ

Q: Can I customize the console prompt generated by Terminality?

A: Yes, Terminality allows for extensive customization of the console prompt. You can modify the Python script to adjust the prompt format according to your preferences.

Q: Does Terminality support other operating systems besides Windows?

A: Terminality is specifically designed for Windows users and may not be compatible with other operating systems out of the box. However, you can adapt the script to work on other platforms if needed.

Q: Is Terminality compatible with Python virtual environments?

A: Yes, Terminality detects Python virtual environments and displays relevant information in the console prompt, making it easy to manage and navigate virtual environment setups.

Q: Can I contribute to Terminality?

A: Contributions are welcome! Feel free to submit pull requests with enhancements, bug fixes, or new features to improve Terminality for the community.

Credits

Project Creator: VermiNew

Terminality was created and is maintained by VermiNew. It is a tool designed to enhance the command line experience for Windows users, providing a customizable console prompt generator that improves productivity and workflow efficiency.

Disclaimer

Terminality and all associated scripts are provided "as is" without warranty of any kind, express or implied. In no event shall the authors, contributors, or copyright holders be liable for any claim, damages, or other liability arising from, out of, or in connection with the use or distribution of Terminality.

How to Contribute

Contributions to Terminality are encouraged! Whether you have a bug fix, feature enhancement, or new idea, feel free to contribute by submitting a pull request or opening an issue on the GitHub repository.

Reporting Issues

If you encounter any issues or bugs while using Terminality, please report them on the GitHub Issues page. Detailed bug reports help us identify and resolve issues more effectively.

License

Terminality is licensed under the MIT License. You are free to use, modify, and distribute the code for personal, educational, or commercial purposes.