fx
| Crates.io | fx |
| lib.rs | fx |
| version | |
| source | src |
| created_at | 2025-01-03 15:05:13.131136 |
| updated_at | 2025-01-03 15:09:07.157303 |
| description | fx is a command-line tool that lists directory in a formatted output. It supports filtering by files 📄 or directories 📁 and displays a tree-like structure 🌳 for easy navigation. |
| homepage | https://github.com/adityarb2003/fx#readme |
| repository | https://github.com/adityarb2003/fx |
| max_upload_size | |
| id | 1502493 |
| Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Aditya Bhat (adityarb2003)
documentation
README
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:
-
Build the release version:
cargo build --release -
Publish to Cargo:
First, log in to Cargo:
cargo loginThen publish the tool:
cargo publish
Contributing
Contributions are welcome! If you'd like to contribute to Spider, please follow these steps:
- Fork the repository.
- Create a feature branch.
- Make your changes.
- Commit your changes.
- Push to your branch.
- Open a pull request with a description of your changes.
License
MIT. See LICENSE for more details.