fx

fx is a command-line utility for displaying directory contents in a visually structured and color-coded format. By default, it lists all files and directories in the current directory. Spider supports various options, allowing users to filter the output to show only files or directories, and also provides a tree-like view of the directory structure.

Installation

Using Cargo

To install Spider, use the following command:

cargo install fx

This will compile and install Spider from the source.

Making It Available Globally

To install Spider globally (for Windows), use the --init flag:

fx --init

NOTE: Administrative privileges are required for this operation.

Usage

Once installed, you can use the following commands to interact with Spider.

Listing Files and Directories

To list the contents of the current directory, run:

fx

This will list all the files and directories

Show Only Directories

To list only directories, use the -d flag:

fx -d

Show Only Files

To list only files, use the -f flag:

fx -f

Display Directory Tree

To display the directory structure in a tree-like format, use the crawl command:

fx crawl

You can also specify a path:

fx crawl /path/to/directory

Deployment

To deploy Spider, follow these steps:

1. Build the release version:

   cargo build --release
   

2. Publish to Cargo:

   First, log in to Cargo:

   cargo login 
   

   Then publish the tool:

   cargo publish
   

Contributing

Contributions are welcome! If you'd like to contribute to Spider, please follow these steps:

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Commit your changes.
5. Push to your branch.
6. Open a pull request with a description of your changes.

License

MIT. See LICENSE for more details.