hf 0.6.0

Cross-platform hidden file library and utility
Documentation

hf

CI Version MSRV Docs License REUSE status

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.

Demo animation

Installation

From source

cargo install hf

Via a package manager

Packaging status

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

completion subcommand generates shell completions to standard output.

The following shells are supported:

  • bash
  • elvish
  • fish
  • nushell
  • powershell
  • zsh

Example:

hf completion bash > hf.bash

Use as a library

This crate is also available as a library.

Run the following command in your project directory:

cargo add --no-default-features hf

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.85.0.

Command-line options

Please see the following:

Source code

The upstream repository is available at https://github.com/sorairolake/hf.git.

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)

  1. This program is distributed under the terms of either the Apache License 2.0 or the MIT License.
  2. Some files are distributed under the terms of the Creative Commons Attribution 4.0 International Public License.

This project is compliant with version 3.3 of the REUSE Specification. See copyright notices of individual files for more details on copyright and licensing information.