Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oleksiiluchnikov/frust
🔍 A command-line tool to extract frontmatter from Markdown files and output it as JSON.
https://github.com/oleksiiluchnikov/frust
frontmatter obsidian-md
Last synced: 7 days ago
JSON representation
🔍 A command-line tool to extract frontmatter from Markdown files and output it as JSON.
- Host: GitHub
- URL: https://github.com/oleksiiluchnikov/frust
- Owner: oleksiiluchnikov
- Created: 2024-07-27T02:19:38.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-27T12:20:57.000Z (5 months ago)
- Last Synced: 2024-10-31T05:05:19.157Z (about 2 months ago)
- Topics: frontmatter, obsidian-md
- Language: Rust
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Frust
Frust is a command-line tool designed to extract frontmatter from Markdown files efficiently. It supports processing individual files or entire directories, including recursive directory traversal.
## Features
- Extracts YAML frontmatter from Markdown files
- Processes individual files or directories
- Supports recursive directory processing for convenient bulk operations
- Offers flexible output options: console or specified file
## Installation
1. Ensure you have [Rust](https://www.rust-lang.org/tools/install) installed on your system.
2. Clone the Frust repository:
```sh
git clone https://github.com/yourusername/frust.git
```
3. Build the project using Cargo:
```sh
cd frust
cargo build --release
```
## Usage
```sh
frust [OPTIONS]
```
### Arguments
- ``: Specify the input file or directory path.
### Options
- `-o, --output `: Provide the output file path. If not specified, the result will be printed to the console.
- `-R, --recursive`: Enable recursive processing of directories.
- `-v, --verbose`: Enable verbose output for detailed logging.
## Examples
### Extract frontmatter from a single Markdown file
```sh
frust input.md
```
### Extract frontmatter from a directory recursively and write to a file
```sh
frust -R -o output.json input_directory/
```
### Verbose output while processing a directory
```sh
frust -R -v input_directory/
```
## License
This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).