Skip to content

Usage Guide

Jump to bottom
LinJHS edited this page Dec 23, 2025 · 4 revisions

Usage Guide

Starting the Application

You can start the application using the command line. It supports several arguments to customize its behavior.

win-folder-manager [options]

Command Line Options

  • -p, --port <number>: Specify the port to run the server on (default is 6800).
  • --host <ip>: Specify the host to bind to (default is 127.0.0.1). Use 0.0.0.0 to allow external access.
  • --no-browser: Prevent the application from automatically opening your default web browser upon startup.
  • --debug: Enable Flask's debug mode (useful for development).

Examples:

# Run on port 8080
win-folder-manager -p 8080

# Allow external access (e.g., for Docker or LAN)
win-folder-manager --host 0.0.0.0

# Run on a headless server (no browser)
win-folder-manager --no-browser

The Interface

The main interface displays a list of all subfolders found in your configured Root Path.

  • Physical Name: The actual name of the folder on the disk.
  • Alias: The localized name (if set) that shows up in Windows Explorer.
  • Icon Status: Shows if a custom icon is set, or if it's using a default one.
  • InfoTip: The text that appears when you hover over the folder in Explorer.

Editing a Folder

Click the Edit button on any folder row to open the edit modal.

1. Folder Alias (LocalizedResourceName)

  • Enter a name here to change how the folder appears in Windows Explorer.
  • Note: The actual folder name on the disk remains unchanged. This is great for keeping organized English directory names (e.g., 2023_Project_A) while displaying friendly Chinese names (e.g., 2023年度A项目).

2. InfoTip

  • Enter text here to set the description tooltip.

3. Icon

  • Select from Library: Choose a pre-configured icon.
  • Custom Path: You can manually enter a path if needed (though adding to the library is recommended).

4. Relative Paths

  • Checkbox: "Try to use relative path"
  • Why?: If your folders and icons are on a portable drive (USB), using absolute paths (e.g., E:\Icons\file.ico) will break if the drive letter changes (e.g., becomes F:).
  • How it works: If checked, the app calculates the path from the folder to the icon (e.g., ..\..\Icons\file.ico). Windows supports this!

Batch Operations

"Convert All to Relative Paths"

  • Located at the top of the list.
  • This tool iterates through all managed folders. If they have a custom icon set, it attempts to convert the absolute path to a relative one.
  • Useful when you've just moved your entire library to a new drive.

Quick Actions

  • Open in Explorer: Opens the folder in Windows File Explorer.
  • Open CMD: Opens a Command Prompt window inside that folder.

AI Auto-Generation

If you have enabled AI in the settings, you will see new buttons in the interface.

Single Folder Generation

  • Click the AI Generate button (magic wand icon) on a folder row.
  • The AI will analyze the folder name and:
    1. Generate a suitable Emoji Icon (converted to .ico).
    2. Create a concise Chinese Alias.
    3. Write a brief InfoTip.

Batch Generation

  • Click the Batch AI Generate button at the top.
  • This will process all folders that do not yet have an alias.
  • It runs in the background (5 folders at a time) to avoid hitting API rate limits.

Clone this wiki locally