🗂️ Projects Directory CLI Tool

A simple interactive CLI tool to create and manage a Projects directory for all of your project-type-specific folders.

---

✨ Features

• 📁 Create a Projects directory in a specified location
• 📦 Select which project types to create subdirectories for
• ❌ Remove specific project folders or the entire Projects directory
• 🎨 Custom folder types and colors via project_types.json

---

📚 Included Project Types (Custom Configuration)

The CLI tool comes preloaded with a set of project types defined in project_types.json. These represent my own personal development setup, including languages, tools, and environments I frequently use.

Each project type can include:

• A display name
• An optional description
• An optional color (either a single hex code or multiple colored segments)

You can freely modify, remove, or add your own project types manually by editing the project_types.json file — and in the future, the tool will make this even easier with the abillity to add new project types directly in the CLI.

🗂️ Current Built-in Project Types

Folder Key	Name	Description	Color
c	C	C language projects
c++	C++	C++ language projects
c#	C#	C# / .NET development
godot	Godot	Game development using Godot engine
java	Java	Java development
javascript	JavaScript	JavaScript/Web projects
kotlin	Kotlin	Kotlin language development
mods	Mods	Game modding
python	Python	Python scripts and projects
rust	Rust	Rust development
robotics	Robotics	Robotics work (e.g. FTC, FRC)
unity	Unity	Unity game engine projects

🎨 Color formatting is used in the CLI interface with chalk, and some types (like Python or Robotics) use multi-colored segments.

---

🧩 Customizing Your Project Types (Planned)

In the future, this tool will support:

• ✅ Easy creation/editing of project types from the CLI
• 🧠 Configuration of presets or setups (bundle multiple project types together)
• 🗂️ Folder templates (e.g. with a .gitignore, README.md, LICENSE etc.)

For now, you can customize by editing project_types.json directly. Here’s an example:

"lua": {
  "name": "Lua",
  "color": "#130A84"
}

---

🚀 Installation

Download the projects-directory-tool.exe from the releases tab and make sure to download the project_types.json as well, make sure to put it in the same directory as the exe.  

🔨 Manual Building

git clone https://github.com/CrownSheep/projects-directory-tool.git
cd projects-directory-tool
npm install
npm link

---

🕹️ Usage

After either downloading the exe or manually building the tool, you can run it from the terminal:

✅ Create a Projects directory and select project types

projects-directory --create

or using the short flag:

projects-directory -c

 

❌ Remove folders from the Projects directory

projects-directory --remove

or using the short flag:

projects-directory -r