DirMode

DirMode is a program written in BASH that lets you surf through directories in your computer.

Warning

DirMode will only work with Linux. This will not work in any other Operating System.

List of Contents

1. DirMode
2. Description
3. Installation
4. Usage
5. Features
6. Contributing
7. License
8. Contact

Description

DirMode is a directory surfing program that enables you to surf through different directories in your computer with just arrow keys. It solves the problem of checking different directories with cd and ls. Traditional method was very simple but doing it multiple times was annoying. To solve that problem I made a simple BASH script that led me to the idea of DirMode.

Installation

This is the step-by-step guide to install and run the project locally:

1. Clone the Repository

git clone https://github.com/SyntaxCorporation/dirmode.git
cd dirmode

2. Run Installation Script

chmod +x install.sh
./install.sh

Usage

Using DirMode is very simple. All we have to do is to type dirmode in terminal and press enter:

dirmode

It has different built-in commands. Each performs a particular task:

Commands	Use
:q	Quit the program
:la	Shows dot files
:ls	Hide dot files
:mf	Shows only files
:md	Shows only directories
:mx	Shows only executable files
:ms	Shows only symlinks
:ma	Removes filter
:rf	Refreshes screen in case of any mess
:i or :j	Jumps to directory or files in a long list Example: :i5,:j15

Features

It has multiple useful features such as:

• Check different directories
• Open files
• Filter the list of contents in a directory
• Create files and directories
• Give and take permissions from a file
• Has a simple TUI
• Navigate through arrow keys

Contributing

Contributions are welcome and encouraged. This project improves through community input, whether small fixes or substantial enhancements.

Ways to Contribute

• Report bugs
  Clearly describe the issue, expected behavior, and steps to reproduce.

• Suggest improvements
  Propose better approaches, optimizations, or new features.

• Submit pull requests
  Fix issues, improve documentation, or add functionality.

• Review code
  Provide constructive feedback on open pull requests.

• Enhance documentation
  Clarify existing content or add missing details.

Guidelines

• Keep changes focused and well-documented.
• Follow existing code style and structure.
• Write meaningful commit messages.
• Test your changes before submitting.

Getting Started

1. Fork the repository
2. Create a new branch (feature/your-feature or fix/issue-name)
3. Make your changes
4. Commit your changes (git commit -m "Add feature")
5. Push to your branch (git push origin your-branch)
6. Open a Pull Request with a clear description

---

Every contribution matters. Even small improvements add value.

License

DirMode is licensed under Apache-2.0 License. See the LICENSE for more information.

Contact

📧 E-mail: blackhydra.developer@gmail.com 💻 Github: github.com/SyntaxCorporation