12 releases
new 0.3.7 | Jan 9, 2025 |
---|---|
0.3.6 | Aug 4, 2024 |
0.3.5 | Jul 3, 2024 |
0.3.4 | Apr 18, 2024 |
0.1.0 | May 26, 2022 |
#219 in Filesystem
213 downloads per month
51KB
871 lines
hf
hf is a cross-platform hidden file library and utility.
This crate supports both Unix and Windows. On Unix, hidden files and
directories are files and directories that starts with a dot character (.
).
On Windows, hidden files and directories are files and directories with the
hidden file attribute. This crate provides operations related to hidden files
and directories, such as making files and directories invisible and visible.
Installation
From source
cargo install hf
From binaries
The release page contains pre-built binaries for Linux, macOS and Windows.
How to build
Please see BUILD.adoc.
Usage
Make files invisible
Don't actually hide anything, just show what would be done:
hf hide -n data.txt
Actually hide files:
hf hide -f data.txt
Make hidden files visible
Don't actually show anything, just show what would be done:
hf show -n .data.txt
Actually show hidden files:
hf show -f .data.txt
Generate shell completion
--generate-completion
option generates shell completions to standard output.
The following shells are supported:
bash
elvish
fish
nushell
powershell
zsh
Example:
hf --generate-completion bash > hf.bash
Use as a library
This crate is also available as a library.
Add this to your Cargo.toml
to use it as a library:
[dependencies]
hf = { version = "0.3.7", default-features = false }
By default, the dependencies required to build the application are also built.
If you disable the default
feature, only the dependencies required to build
the library will be built.
Documentation
See the documentation for more details.
Minimum supported Rust version
The minimum supported Rust version (MSRV) of this library is v1.74.0.
Command-line options
Please see the following:
Source code
The upstream repository is available at https://github.com/sorairolake/hf.git.
The source code is also available at:
Changelog
Please see CHANGELOG.adoc.
Contributing
Please see CONTRIBUTING.adoc.
Home page
https://sorairolake.github.io/hf/
License
Copyright (C) 2022 Shun Sakai (see AUTHORS.adoc)
- This program is distributed under the terms of either the Apache License 2.0 or the MIT License.
- Some files are distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
This project is compliant with version 3.2 of the REUSE Specification. See copyright notices of individual files for more details on copyright and licensing information.
Dependencies
~0–38MB
~565K SLoC